all: updated FSF address in GPL text
[sip-router] / modules / db_mysql / km_res.h
1 /* 
2  * $Id$ 
3  *
4  * MySQL module result related functions
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  * Copyright (C) 2007-2008 1&1 Internet AG
8  *
9  * This file is part of Kamailio, a free SIP server.
10  *
11  * Kamailio is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version
15  *
16  * Kamailio is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License 
22  * along with this program; if not, write to the Free Software 
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
24  */
25
26 /*! \file
27  *  \brief DB_MYSQL :: Result related functions
28  *  \ingroup db_mysql
29  *  Module: \ref db_mysql
30  */
31
32
33 #ifndef KM_RES_H
34 #define KM_RES_H
35
36 #include "../../lib/srdb1/db_res.h"
37 #include "../../lib/srdb1/db_con.h"
38
39
40 struct my_res {
41         MYSQL_RES* res;          /*!< Actual result */
42         MYSQL_ROW row;           /*!< Actual row in the result */
43 };
44
45 /*
46  * Some convenience wrappers
47  */
48 #define RES_RESULT(db_res)     (((struct my_res*)((db_res)->ptr))->res)
49 #define RES_ROW(db_res)        (((struct my_res*)((db_res)->ptr))->row)
50
51
52 /*!
53  * \brief Fill the result structure with data from database
54  * \param _h database connection
55  * \param _r database result
56  * \return 0 on success, negative on failure
57  */
58 int db_mysql_convert_result(const db1_con_t* _h, db1_res_t* _r);
59
60
61 /*!
62  * \brief Get and convert columns from a result
63  * \param _h database connection
64  * \param _r database result set
65  * \return 0 on success, negative on failure
66  */
67 int db_mysql_get_columns(const db1_con_t* _h, db1_res_t* _r);
68
69
70 /*!
71  * \brief Allocate new result set with private structure
72  * \return db1_res_t object on success, NULL on failure
73  */
74 db1_res_t* db_mysql_new_result(void);
75
76 #endif