aboutsummaryrefslogtreecommitdiffstats
path: root/src/cfg_file.h
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@rambler-co.ru>2009-02-06 15:00:38 +0300
committerVsevolod Stakhov <vsevolod@rambler-co.ru>2009-02-06 15:00:38 +0300
commit7f8de787946b883cc791bf6c0bcb514496caf074 (patch)
tree8c828243de051ba25ed3806d2a4fca9eaf3cae83 /src/cfg_file.h
parenta3c3fb96d13f2cbfc5ab984c1886441ec0e9b47b (diff)
downloadrspamd-7f8de787946b883cc791bf6c0bcb514496caf074.tar.gz
rspamd-7f8de787946b883cc791bf6c0bcb514496caf074.zip
* Make doxygen happy about structures members
Diffstat (limited to 'src/cfg_file.h')
-rw-r--r--src/cfg_file.h156
1 files changed, 78 insertions, 78 deletions
diff --git a/src/cfg_file.h b/src/cfg_file.h
index b80f4081c..a7ad3eaaf 100644
--- a/src/cfg_file.h
+++ b/src/cfg_file.h
@@ -1,8 +1,8 @@
-/*
- * $Id$
+/**
+ * @file cfg_file.h
+ * Config file parser and config routines API
*/
-
#ifndef CFG_FILE_H
#define CFG_FILE_H
@@ -72,37 +72,37 @@ enum rspamd_log_type {
* Regexp structure
*/
struct rspamd_regexp {
- enum rspamd_regexp_type type; /** < regexp type */
- char *regexp_text; /** < regexp text representation */
- GRegex *regexp; /** < glib regexp structure */
- char *header; /** < header name for header regexps */
+ enum rspamd_regexp_type type; /**< regexp type */
+ char *regexp_text; /**< regexp text representation */
+ GRegex *regexp; /**< glib regexp structure */
+ char *header; /**< header name for header regexps */
};
/**
* Memcached server object
*/
struct memcached_server {
- struct upstream up; /** < common upstream base */
- struct in_addr addr; /** < address of server */
- uint16_t port; /** < port to connect */
- short alive; /** < is this server alive */
- short int num; /** < number of servers in case of mirror */
+ struct upstream up; /**< common upstream base */
+ struct in_addr addr; /**< address of server */
+ uint16_t port; /**< port to connect */
+ short alive; /**< is this server alive */
+ short int num; /**< number of servers in case of mirror */
};
/**
* Perl module list item
*/
struct perl_module {
- char *path; /** < path to module */
- LIST_ENTRY (perl_module) next; /** < chain link */
+ char *path; /**< path to module */
+ LIST_ENTRY (perl_module) next; /**< chain link */
};
/**
* Module option
*/
struct module_opt {
- char *param; /** < parameter name */
- char *value; /** < paramater value */
+ char *param; /**< parameter name */
+ char *value; /**< paramater value */
LIST_ENTRY (module_opt) next;
};
@@ -110,85 +110,85 @@ struct module_opt {
* Statfile config definition
*/
struct statfile {
- char *alias; /** < alias of statfile */
- char *pattern; /** < filesystem pattern (with %r or %f) */
- double weight; /** < weight scale */
- char *metric; /** < metric name */
- size_t size; /** < size of statfile */
- struct tokenizer *tokenizer; /** < tokenizer used for statfile */
+ char *alias; /**< alias of statfile */
+ char *pattern; /**< filesystem pattern (with %r or %f) */
+ double weight; /**< weight scale */
+ char *metric; /**< metric name */
+ size_t size; /**< size of statfile */
+ struct tokenizer *tokenizer; /**< tokenizer used for statfile */
};
/**
* Config option for importing to perl module
*/
struct config_scalar {
- void *pointer; /** < pointer to data */
+ void *pointer; /**< pointer to data */
enum {
SCALAR_TYPE_INT,
SCALAR_TYPE_UINT,
SCALAR_TYPE_STR,
SCALAR_TYPE_SIZE,
- } type; /** < type of data */
+ } type; /**< type of data */
};
/**
* Structure that stores all config data
*/
struct config_file {
- memory_pool_t *cfg_pool; /** < memory pool for config */
- char *cfg_name; /** < name of config file */
- char *pid_file; /** < name of pid file */
- char *temp_dir; /** < dir for temp files */
-
- char *bind_host; /** < bind line */
- struct in_addr bind_addr; /** < bind address in case of TCP socket */
- uint16_t bind_port; /** < bind port in case of TCP socket */
- uint16_t bind_family; /** < bind type (AF_UNIX or AF_INET) */
-
- char *control_host; /** < bind line for controller */
- struct in_addr control_addr; /** < bind address for controller */
- uint16_t control_port; /** < bind port for controller */
- uint16_t control_family; /** < bind family for controller */
- int controller_enabled; /** < whether controller is enabled */
- char *control_password; /** < controller password */
-
- int no_fork; /** < if 1 do not call daemon() */
- unsigned int workers_number; /** < number of workers */
-
- enum rspamd_log_type log_type; /** < log type */
- int log_facility; /** < log facility in case of syslog */
- int log_level; /** < log level trigger */
- char *log_file; /** < path to logfile in case of file logging */
- int log_fd; /** < log descriptor in case of file logging */
-
- size_t max_statfile_size; /** < maximum size for statfile */
-
- struct memcached_server memcached_servers[MAX_MEMCACHED_SERVERS]; /** < memcached servers */
- size_t memcached_servers_num; /** < number of memcached servers */
- memc_proto_t memcached_protocol; /** < memcached protocol */
- unsigned int memcached_error_time; /** < memcached error time (see upstream documentation) */
- unsigned int memcached_dead_time; /** < memcached dead time */
- unsigned int memcached_maxerrors; /** < maximum number of errors */
- unsigned int memcached_connect_timeout; /** < connection timeout */
-
- LIST_HEAD (modulesq, perl_module) perl_modules; /** < linked list of perl modules to load */
-
- LIST_HEAD (headersq, filter) header_filters; /** < linked list of all header's filters */
- LIST_HEAD (mimesq, filter) mime_filters; /** < linked list of all mime filters */
- LIST_HEAD (messagesq, filter) message_filters; /** < linked list of all message's filters */
- LIST_HEAD (urlsq, filter) url_filters; /** < linked list of all url's filters */
- char *header_filters_str; /** < string of header's filters */
- char *mime_filters_str; /** < string of mime's filters */
- char *message_filters_str; /** < string of message's filters */
- char *url_filters_str; /** < string for url's filters */
- GHashTable* modules_opts; /** < hash for module options indexed by module name */
- GHashTable* variables; /** < hash of $variables defined in config, indexed by variable name */
- GHashTable* metrics; /** < hash of metrics indexed by metric name */
- GHashTable* factors; /** < hash of factors indexed by symbol name */
- GHashTable* c_modules; /** < hash of c modules indexed by module name */
- GHashTable* composite_symbols; /** < hash of composite symbols indexed by its name */
- GHashTable* statfiles; /** < hash of defined statfiles indexed by alias */
- GHashTable* cfg_params; /** < all cfg params indexed by its name in this structure */
+ memory_pool_t *cfg_pool; /**< memory pool for config */
+ char *cfg_name; /**< name of config file */
+ char *pid_file; /**< name of pid file */
+ char *temp_dir; /**< dir for temp files */
+
+ char *bind_host; /**< bind line */
+ struct in_addr bind_addr; /**< bind address in case of TCP socket */
+ uint16_t bind_port; /**< bind port in case of TCP socket */
+ uint16_t bind_family; /**< bind type (AF_UNIX or AF_INET) */
+
+ char *control_host; /**< bind line for controller */
+ struct in_addr control_addr; /**< bind address for controller */
+ uint16_t control_port; /**< bind port for controller */
+ uint16_t control_family; /**< bind family for controller */
+ int controller_enabled; /**< whether controller is enabled */
+ char *control_password; /**< controller password */
+
+ int no_fork; /**< if 1 do not call daemon() */
+ unsigned int workers_number; /**< number of workers */
+
+ enum rspamd_log_type log_type; /**< log type */
+ int log_facility; /**< log facility in case of syslog */
+ int log_level; /**< log level trigger */
+ char *log_file; /**< path to logfile in case of file logging */
+ int log_fd; /**< log descriptor in case of file logging */
+
+ size_t max_statfile_size; /**< maximum size for statfile */
+
+ struct memcached_server memcached_servers[MAX_MEMCACHED_SERVERS]; /**< memcached servers */
+ size_t memcached_servers_num; /**< number of memcached servers */
+ memc_proto_t memcached_protocol; /**< memcached protocol */
+ unsigned int memcached_error_time; /**< memcached error time (see upstream documentation) */
+ unsigned int memcached_dead_time; /**< memcached dead time */
+ unsigned int memcached_maxerrors; /**< maximum number of errors */
+ unsigned int memcached_connect_timeout; /**< connection timeout */
+
+ LIST_HEAD (modulesq, perl_module) perl_modules; /**< linked list of perl modules to load */
+
+ LIST_HEAD (headersq, filter) header_filters; /**< linked list of all header's filters */
+ LIST_HEAD (mimesq, filter) mime_filters; /**< linked list of all mime filters */
+ LIST_HEAD (messagesq, filter) message_filters; /**< linked list of all message's filters */
+ LIST_HEAD (urlsq, filter) url_filters; /**< linked list of all url's filters */
+ char *header_filters_str; /**< string of header's filters */
+ char *mime_filters_str; /**< string of mime's filters */
+ char *message_filters_str; /**< string of message's filters */
+ char *url_filters_str; /**< string for url's filters */
+ GHashTable* modules_opts; /**< hash for module options indexed by module name */
+ GHashTable* variables; /**< hash of $variables defined in config, indexed by variable name */
+ GHashTable* metrics; /**< hash of metrics indexed by metric name */
+ GHashTable* factors; /**< hash of factors indexed by symbol name */
+ GHashTable* c_modules; /**< hash of c modules indexed by module name */
+ GHashTable* composite_symbols; /**< hash of composite symbols indexed by its name */
+ GHashTable* statfiles; /**< hash of defined statfiles indexed by alias */
+ GHashTable* cfg_params; /**< all cfg params indexed by its name in this structure */
};
/**