modules: several small doxygen bug fixes
[sip-router] / modules / db_mysql / mysql_mod.c
1 /*
2  * $Id$
3  *
4  * MySQL module interface
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the ser software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * ser is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29 /*
30  * History:
31  * --------
32  *  2003-03-11  updated to the new module exports interface (andrei)
33  *  2003-03-16  flags export parameter added (janakj)
34  */
35 /** @addtogroup mysql
36  *  @{
37  */
38  
39 #include "mysql_mod.h"
40 #include "km_db_mysql.h"
41
42 #include "my_uri.h"
43 #include "my_con.h"
44 #include "my_cmd.h"
45 #include "my_fld.h"
46 #include "my_res.h"
47
48 #include "../../sr_module.h"
49 #include "../../lib/srdb2/db.h"
50 #include "../../dprint.h"
51
52 int my_ping_interval = 5 * 60; /* Default is 5 minutes */
53 unsigned int my_connect_to = 2; /* 2 s by default */
54 unsigned int my_send_to = 0; /*  enabled only for mysql >= 5.25  */
55 unsigned int my_recv_to = 0; /* enabled only for mysql >= 5.25 */
56 unsigned int my_retries = 1;    /* Number of retries when command fails */
57
58 unsigned long my_client_ver = 0;
59
60 struct mysql_counters_h mysql_cnts_h;
61 counter_def_t mysql_cnt_defs[] =  {
62         {&mysql_cnts_h.driver_err, "driver_errors", 0, 0, 0,
63                 "incremented each time a Mysql error happened because the server/connection has failed."},
64         {0, 0, 0, 0, 0, 0 }
65 };
66 #define DEFAULT_MY_SEND_TO  2   /* in seconds */
67 #define DEFAULT_MY_RECV_TO  4   /* in seconds */
68
69 static int mysql_mod_init(void);
70
71 MODULE_VERSION
72
73
74 /*
75  * MySQL database module interface
76  */
77 static cmd_export_t cmds[] = {
78         {"db_ctx",    (cmd_function)NULL,         0, 0, 0},
79         {"db_con",    (cmd_function)my_con,       0, 0, 0},
80         {"db_uri",    (cmd_function)my_uri,       0, 0, 0},
81         {"db_cmd",    (cmd_function)my_cmd,       0, 0, 0},
82         {"db_put",    (cmd_function)my_cmd_exec,  0, 0, 0},
83         {"db_del",    (cmd_function)my_cmd_exec,  0, 0, 0},
84         {"db_get",    (cmd_function)my_cmd_exec,  0, 0, 0},
85         {"db_upd",    (cmd_function)my_cmd_exec,  0, 0, 0},
86         {"db_sql",    (cmd_function)my_cmd_exec,  0, 0, 0},
87         {"db_res",    (cmd_function)my_res,       0, 0, 0},
88         {"db_fld",    (cmd_function)my_fld,       0, 0, 0},
89         {"db_first",  (cmd_function)my_cmd_first, 0, 0, 0},
90         {"db_next",   (cmd_function)my_cmd_next,  0, 0, 0},
91         {"db_setopt", (cmd_function)my_setopt,    0, 0, 0},
92         {"db_getopt", (cmd_function)my_getopt,    0, 0, 0},
93         {"db_bind_api",         (cmd_function)db_mysql_bind_api,      0, 0, 0},
94         {0, 0, 0, 0, 0}
95 };
96
97
98 /*
99  * Exported parameters
100  */
101 static param_export_t params[] = {
102         {"ping_interval",   PARAM_INT, &my_ping_interval},
103         {"connect_timeout", PARAM_INT, &my_connect_to},
104         {"send_timeout",    PARAM_INT, &my_send_to},
105         {"receive_timeout", PARAM_INT, &my_recv_to},
106         {"retries",         PARAM_INT, &my_retries},
107
108         {"timeout_interval", INT_PARAM, &db_mysql_timeout_interval},
109         {"auto_reconnect",   INT_PARAM, &db_mysql_auto_reconnect},
110         {0, 0, 0}
111 };
112
113
114 struct module_exports exports = {
115         "db_mysql",
116         cmds,
117         0,               /* RPC method */
118         params,          /*  module parameters */
119         mysql_mod_init,  /* module initialization function */
120         0,               /* response function*/
121         0,               /* destroy function */
122         0,               /* oncancel function */
123         0                /* per-child init function */
124 };
125
126
127 static int mysql_mod_init(void)
128 {
129 #if MYSQL_VERSION_ID >= 40101
130         my_client_ver = mysql_get_client_version();
131         if ((my_client_ver >= 50025) || 
132                 ((my_client_ver >= 40122) && 
133                  (my_client_ver < 50000))) {
134                 if (my_send_to == 0) {
135                         my_send_to= DEFAULT_MY_SEND_TO;
136                 }
137                 if (my_recv_to == 0) {
138                         my_recv_to= DEFAULT_MY_RECV_TO;
139                 }
140         } else if (my_recv_to || my_send_to) {
141                 LOG(L_WARN, "WARNING: mysql send or received timeout set, but "
142                         " not supported by the installed mysql client library"
143                         " (needed at least 4.1.22 or 5.0.25, but installed %ld)\n",
144                         my_client_ver);
145         }
146 #else
147         if (my_recv_to || my_send_to) {
148                 LOG(L_WARN, "WARNING: mysql send or received timeout set, but "
149                         " not supported by the mysql client library used to compile"
150                         " the mysql module (needed at least 4.1.1 but "
151                         " compiled against %ld)\n", MYSQL_VERSION_ID);
152         }
153 #endif
154         if (counter_register_array("mysql", mysql_cnt_defs) < 0)
155                 goto error;
156
157         return kam_mysql_mod_init();
158 error:
159         return -1;
160 }
161
162 /** @} */