modules: several small doxygen bug fixes
[sip-router] / modules / db_mysql / my_con.h
1 /* 
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
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 _MY_CON_H
30 #define _MY_CON_H  1
31
32 #include "../../lib/srdb2/db_pool.h"
33 #include "../../lib/srdb2/db_con.h"
34 #include "../../lib/srdb2/db_uri.h"
35
36 #include <time.h>
37 #include <mysql/mysql.h>
38
39 enum my_con_flags {
40         MY_CONNECTED = 1
41 };
42
43 typedef struct my_con {
44         /* Generic part of the structure */
45         db_pool_entry_t gen;
46
47         MYSQL* con;
48         unsigned int flags;
49         
50         /* We keep the number of connection resets in this variable, this
51          * variable is incremented each time the module performs a disconnect
52          * on the connection. This is used by my_cmd related functions to
53          * check if a pre-compiled command needs to be uploaded to the server
54          * before executing them.
55          */
56         unsigned int resets;
57 } my_con_t;
58
59
60 /*
61  * Create a new connection structure,
62  * open the MySQL connection and set reference count to 1
63  */
64 int my_con(db_con_t* con);
65
66 int my_con_connect(db_con_t* con);
67 void my_con_disconnect(db_con_t* con);
68
69 #endif /* _MY_CON_H */