all: updated FSF address in GPL text
[sip-router] / cfg / cfg_select.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2008 iptelorg GmbH
5  *
6  * This file is part of SIP-router, a free SIP server.
7  *
8  * SIP-router 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  * SIP-router is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  *
22  * History
23  * -------
24  *  2008-01-10  Initial version (Miklos)
25  */
26
27 #ifndef _CFG_SELECT_H
28 #define _CFG_SELECT_H
29
30 #include "../select.h"
31
32 struct cfg_read_handle {
33         void    *group;
34         void    *var;
35 };
36
37 /* free the list of not yet fixed selects */
38 void cfg_free_selects(void);
39
40 /* fix-up the select calls */
41 int cfg_fixup_selects(void);
42
43 int select_cfg_var(str *res, select_t *s, struct sip_msg *msg);
44
45 /* fix-up function for read_cfg_var()
46  *
47  * return value:
48  * >0 - success
49  *  0 - the variable has not been declared yet, but it will be automatically
50  *      fixed-up later.
51  * <0 - error
52  */
53 int read_cfg_var_fixup(char *gname, char *vname, struct cfg_read_handle *read_handle);
54
55 /* read the value of a variable via a group and variable name previously fixed up
56  * Returns the type of the variable
57  */
58 unsigned int read_cfg_var(struct cfg_read_handle *read_handle, void **val);
59
60 /* wrapper functions for read_cfg_var() -- convert the value to the requested format */
61 int read_cfg_var_int(struct cfg_read_handle *read_handle, int *val);
62 int read_cfg_var_str(struct cfg_read_handle *read_handle, str *val);
63
64 /* return the selected group instance */
65 int cfg_selected_inst(str *res, select_t *s, struct sip_msg *msg);
66
67 #endif /* _CFG_SELECT_H */