all: updated FSF address in GPL text
[sip-router] / modules / htable / ht_api.h
1 /**
2  * $Id$
3  *
4  * Copyright (C) 2008 Elena-Ramona Modroiu (asipto.com)
5  *
6  * This file is part of kamailio, a free SIP server.
7  *
8  * Kamailio 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  * Kamailio 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                        
23 #ifndef _HT_API_H_
24 #define _HT_API_H_
25
26 #include <time.h>
27
28 #include "../../usr_avp.h"
29 #include "../../locking.h"
30 #include "../../pvar.h"
31
32 #define ht_compute_hash(_s)        core_case_hash(_s,0,0)
33 #define ht_get_entry(_h,_size)    (_h)&((_size)-1)
34
35 typedef struct _ht_cell
36 {
37     unsigned int cellid;
38     unsigned int msize;
39         int flags;
40         str name;
41         int_str value;
42         time_t  expire;
43     struct _ht_cell *prev;
44     struct _ht_cell *next;
45 } ht_cell_t;
46
47 typedef struct _ht_entry
48 {
49         unsigned int esize;
50         ht_cell_t *first;
51         gen_lock_t lock;        
52 } ht_entry_t;
53
54 typedef struct _ht
55 {
56         str name;
57         unsigned int htid;
58         unsigned int htexpire;
59         str dbtable;
60         int dbmode;
61         int flags;
62         int_str initval;
63         int updateexpire;
64         unsigned int htsize;
65         int dmqreplicate;
66         ht_entry_t *entries;
67         struct _ht *next;
68 } ht_t;
69
70 typedef struct _ht_pv {
71         str htname;
72         ht_t *ht;
73         pv_elem_t *pve;
74 } ht_pv_t, *ht_pv_p;
75
76 int ht_add_table(str *name, int autoexp, str *dbtable, int size, int dbmode,
77                 int itype, int_str *ival, int updateexpire, int dmqreplicate);
78 int ht_init_tables(void);
79 int ht_destroy(void);
80 int ht_set_cell(ht_t *ht, str *name, int type, int_str *val, int mode);
81 int ht_del_cell(ht_t *ht, str *name);
82 ht_cell_t* ht_cell_value_add(ht_t *ht, str *name, int val, int mode,
83                 ht_cell_t *old);
84
85 int ht_dbg(void);
86 ht_cell_t* ht_cell_pkg_copy(ht_t *ht, str *name, ht_cell_t *old);
87 int ht_cell_pkg_free(ht_cell_t *cell);
88 int ht_cell_free(ht_cell_t *cell);
89
90 int ht_table_spec(char *spec);
91 ht_t* ht_get_table(str *name);
92 int ht_db_load_tables(void);
93 int ht_db_sync_tables(void);
94
95 int ht_has_autoexpire(void);
96 void ht_timer(unsigned int ticks, void *param);
97 int ht_set_cell_expire(ht_t *ht, str *name, int type, int_str *val);
98 int ht_get_cell_expire(ht_t *ht, str *name, unsigned int *val);
99
100 int ht_rm_cell_re(str *sre, ht_t *ht, int mode);
101 int ht_count_cells_re(str *sre, ht_t *ht, int mode);
102 ht_t *ht_get_root(void);
103
104 #endif