@cfg_get.<group_name>.<var_name> is documented
[sip-router] / cfg_core.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2007 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  * HOWTO:
28  *      If you need a new configuration variable within the core, put it into
29  *      struct cfg_goup_core, and define it in cfg_core.c:core_cfg_def array.
30  *      The default value of the variable must be inserted into
31  *      cfg_core.c:default_core_cfg
32  *      Include this header file in your source code, and retrieve the
33  *      value with cfg_get(core, core_cfg, variable_name).
34  *
35  * History
36  * -------
37  *  2007-12-03  Initial version (Miklos)
38  */
39
40 #ifndef _CFG_CORE_H
41 #define _CFG_CORE_H
42
43 #include "cfg/cfg.h"
44
45 extern void     *core_cfg;
46
47 struct cfg_group_core {
48         int     debug;
49 #ifdef USE_DST_BLACKLIST
50         int     use_dst_blacklist; /* 1 if blacklist is enabled */
51         unsigned int    blst_timeout; /* blacklist entry ttl */
52         unsigned int    blst_max_mem; /* maximum memory used for the
53                                         blacklist entries */
54 #endif
55 };
56
57 extern struct cfg_group_core default_core_cfg;
58 extern cfg_def_t core_cfg_def[];
59
60 #endif /* _CFG_CORE_H */