Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
dbpool_p.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * dbpool_p.h - Database pool private header.
59  *
60  * Alexander Malysh <a.malysh@centrium.de>
61  */
62 
63 #ifndef DBPOOL_P_H
64 #define DBPOOL_P_H 1
65 
66 
67 struct db_ops {
68  /*
69  * Open db connection with given config params.
70  * Config params are specificaly for each database type.
71  * return NULL if error occurs ; established connection's pointer otherwise
72  */
73  void* (*open) (const DBConf *conf);
74  /*
75  * close given connection.
76  */
77  void (*close) (void *conn);
78  /*
79  * check if given connection still alive,
80  * return -1 if not or error occurs ; 0 if all was fine
81  * NOTE: this function is optional
82  */
83  int (*check) (void *conn);
84  /*
85  * Destroy specificaly configuration struct.
86  */
87  void (*conf_destroy) (DBConf *conf);
88  /*
89  * Database specific select.
90  * Note: Result will be stored as follows:
91  * result is the list of rows each row will be stored also as list each column is stored as Octstr.
92  * If someone has better idea please tell me ...
93  *
94  * @params conn - database specific connection; sql - sql statement ;
95  * binds - list of Octstr values for binding holes in sql (NULL if no binds);
96  * result - result will be saved here
97  * @return 0 if all was fine ; -1 otherwise
98  */
99  int (*select) (void *conn, const Octstr *sql, List *binds, List **result);
100  /*
101  * Database specific update/insert/delete.
102  * @params conn - database specific connection ; sql - sql statement;
103  * binds - list of Octstr values for binding holes in sql (NULL if no binds);
104  * @return #rows processed ; -1 if a error occurs
105  */
106  int (*update) (void *conn, const Octstr *sql, List *binds);
107 };
108 
109 struct DBPool
110 {
111  List *pool; /* queue representing the pool */
112  unsigned int max_size; /* max #connections */
113  unsigned int curr_size; /* current #connections */
114  DBConf *conf; /* the database type specific configuration block */
115  struct db_ops *db_ops; /* the database operations callbacks */
116  enum db_type db_type; /* the type of database */
117 };
118 
119 
120 #endif
121 
db_type
Definition: dbpool.h:76
List * pool
Definition: dbpool_p.h:111
int(* check)(void *conn)
Definition: dbpool_p.h:83
int(* update)(void *conn, const Octstr *sql, List *binds)
Definition: dbpool_p.h:106
void(* close)(void *conn)
Definition: dbpool_p.h:77
unsigned int max_size
Definition: dbpool_p.h:112
DBConf * conf
Definition: dbpool_p.h:114
void(* conf_destroy)(DBConf *conf)
Definition: dbpool_p.h:87
unsigned int curr_size
Definition: dbpool_p.h:113
Definition: dbpool.h:164
Definition: octstr.c:118
enum db_type db_type
Definition: dbpool_p.h:116
int(* select)(void *conn, const Octstr *sql, List *binds, List **result)
Definition: dbpool_p.h:99
struct db_ops * db_ops
Definition: dbpool_p.h:115
Definition: list.c:102
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.