- #define CFG_INPUT_SHIFT is used instead of a hardwired value
[sip-router] / cfg / cfg_ctx.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  * History
28  * -------
29  *  2007-12-03  Initial version (Miklos)
30  */
31
32 #ifndef _CFG_CTX_H
33 #define _CFG_CTX_H
34
35 #include "../str.h"
36 #include "../locking.h"
37 #include "cfg.h"
38 #include "cfg_struct.h"
39
40 /* linked list of variables with their new values */
41 typedef struct _cfg_changed_var {
42         cfg_group_t     *group;
43         cfg_mapping_t   *var;
44         struct _cfg_changed_var *next;
45
46         /* blob that contains the new value */
47         unsigned char   new_val[1];
48 } cfg_changed_var_t;
49
50 /* callback that is called when a new group is declared */
51 typedef void (*cfg_on_declare)(str *, cfg_def_t *);
52
53 /* linked list of registered contexts */
54 typedef struct _cfg_ctx {
55         /* variables that are already changed
56         but have not been committed yet */
57         cfg_changed_var_t       *changed_first;
58         cfg_changed_var_t       *changed_last;
59         /* lock potecting the the linked-list of
60         changed variables */
61         gen_lock_t              lock;
62
63         /* callback that is called when a new
64         group is registered */
65         cfg_on_declare          on_declare_cb;
66
67         struct _cfg_ctx *next;
68 } cfg_ctx_t;
69
70 #define CFG_CTX_LOCK(ctx)       lock_get(&(ctx)->lock)
71 #define CFG_CTX_UNLOCK(ctx)     lock_release(&(ctx)->lock)
72
73 /* creates a new config context that is an interface to the
74  * cfg variables with write permission */
75 cfg_ctx_t *cfg_register_ctx(cfg_on_declare on_declare_cb);
76
77 /* free the memory allocated for the contexts */
78 void cfg_ctx_destroy(void);
79
80 /* set the value of a variable without the need of explicit commit */
81 int cfg_set_now(cfg_ctx_t *ctx, str *group_name, str *var_name,
82                         void *val, unsigned int val_type);
83 int cfg_set_now_int(cfg_ctx_t *ctx, str *group_name, str *var_name, int val);
84 int cfg_set_now_string(cfg_ctx_t *ctx, str *group_name, str *var_name, char *val);
85 int cfg_set_now_str(cfg_ctx_t *ctx, str *group_name, str *var_name, str *val);
86
87 /* sets the value of a variable but does not commit the change */
88 int cfg_set_delayed(cfg_ctx_t *ctx, str *group_name, str *var_name,
89                         void *val, unsigned int val_type);
90 int cfg_set_delayed_int(cfg_ctx_t *ctx, str *group_name, str *var_name, int val);
91 int cfg_set_delayed_string(cfg_ctx_t *ctx, str *group_name, str *var_name, char *val);
92 int cfg_set_delayed_str(cfg_ctx_t *ctx, str *group_name, str *var_name, str *val);
93
94 /* commits the previously prepared changes within the context */
95 int cfg_commit(cfg_ctx_t *ctx);
96
97 /* drops the not yet committed changes within the context */
98 int cfg_rollback(cfg_ctx_t *ctx);
99
100 /* returns the value of a variable */
101 int cfg_get_by_name(cfg_ctx_t *ctx, str *group_name, str *var_name,
102                         void **val, unsigned int *val_type);
103
104 /* returns the description of a variable */
105 int cfg_help(cfg_ctx_t *ctx, str *group_name, str *var_name,
106                         char **ch, unsigned int *input_type);
107
108 /* notify the drivers about the new config definition */
109 void cfg_notify_drivers(char *group_name, int group_name_len, cfg_def_t *def);
110
111 /* initialize the handle for cfg_get_group_next() */
112 #define cfg_get_group_init(handle) \
113         (*(handle)) = (void *)cfg_group
114
115 /* returns the group name and the cfg structure definition,
116  * and moves the handle to the next group
117  * Return value:
118  *      0: no more group
119  *      1: group exists
120  *
121  * can be used as follows:
122  *
123  * void *handle;
124  * cfg_get_group_init(&handle)
125  * while (cfg_get_group_next(&handle, &name, &def)) {
126  *      ...
127  * }
128  */
129 int cfg_get_group_next(void **h,
130                         str *gname, cfg_def_t **def);
131
132 /* Initialize the handle for cfg_diff_next()
133  * WARNING: keeps the context lock held, do not forget
134  * to release it with cfg_diff_release()
135  */
136 int cfg_diff_init(cfg_ctx_t *ctx,
137                 void **h);
138
139 /* return the pending changes that have not been
140  * committed yet
141  * can be used as follows:
142  *
143  * void *handle;
144  * if (cfg_diff_init(ctx, &handle)) return -1
145  * while (cfg_diff_next(&handle
146  *                      &group_name, &var_name,
147  *                      &old_val, &new_val
148  *                      &val_type)
149  * ) {
150  *              ...
151  * }
152  * cfg_diff_release(ctx);
153  */
154 int cfg_diff_next(void **h,
155                         str *gname, str *vname,
156                         void **old_val, void **new_val,
157                         unsigned int *val_type);
158
159 /* destroy the handle of cfg_diff_next() */
160 void cfg_diff_release(cfg_ctx_t *ctx);
161
162 #endif /* _CFG_CTX_H */