Merge kamailio modules into sip-router master branch
[sip-router] / lib / srdb2 / db_pool.h
1 /* 
2  * $Id$
3  *
4  * Copyright (C) 2001-2005 iptel.org
5  * Copyright (C) 2006-2007 iptelorg GmbH
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License 
25  * along with this program; if not, write to the Free Software 
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28
29 #ifndef _DB_POOL_H
30 #define _DB_POOL_H  1
31
32 /** \ingroup DB_API 
33  * @{ 
34  */
35
36 #include "db_drv.h"
37 #include "db_uri.h"
38 #include "../../list.h"
39 #include <sys/types.h>
40
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif /* __cplusplus */
45
46
47 /*
48  * This is a stub that contains all attributes
49  * that pool members must have, it is not really
50  * used, real connection structures are created
51  * by database backends. All such structures (
52  * created by the backends) must have these
53  * attributes.
54  */
55 typedef struct db_pool_entry {
56         db_drv_t drv_gen;  /* Generic part of the driver specific data */
57         SLIST_ENTRY(db_pool_entry) next;
58         db_uri_t* uri;     /* Pointer to the URI representing the connection */
59         unsigned int ref;  /* Reference count */
60 } db_pool_entry_t;
61
62
63 int db_pool_entry_init(struct db_pool_entry *entry, void* free_func, db_uri_t* uri);
64 void db_pool_entry_free(struct db_pool_entry* entry);   
65
66
67 /*
68  * Search the pool for a connection with
69  * the identifier equal to id, NULL is returned
70  * when no connection is found
71  */
72 struct db_pool_entry* db_pool_get(db_uri_t* uri);
73
74
75 /*
76  * Insert a new connection into the pool
77  */
78 void db_pool_put(struct db_pool_entry* entry);
79
80
81 /*
82  * Release connection from the pool, the function
83  * would return 1 when if the connection is not
84  * referenced anymore and thus can be closed and
85  * deleted by the backend. The function returns
86  * 0 if the connection should still be kept open
87  * because some other module is still using it.
88  * The function returns -1 if the connection is
89  * not in the pool.
90  */
91 int db_pool_remove(struct db_pool_entry* entry);
92
93 #ifdef __cplusplus
94 }
95 #endif /* __cplusplus */
96
97 /** @} */
98
99 #endif /* _DB_POOL_H */