Merged revisions 115308 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / res_odbc.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  * Copyright (C) 2004 - 2005, Anthony Minessale II
6  * Copyright (C) 2006, Tilghman Lesher
7  *
8  * Mark Spencer <markster@digium.com>
9  * Anthony Minessale <anthmct@yahoo.com>
10  * Tilghman Lesher <res_odbc_200603@the-tilghman.com>
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  * This program is free software, distributed under the terms of
19  * the GNU General Public License Version 2. See the LICENSE file
20  * at the top of the source tree.
21  */
22
23 /*! \file
24  * \brief ODBC resource manager
25  */
26
27 #ifndef _ASTERISK_RES_ODBC_H
28 #define _ASTERISK_RES_ODBC_H
29
30 #include <sql.h>
31 #include <sqlext.h>
32 #include <sqltypes.h>
33
34 typedef enum { ODBC_SUCCESS=0, ODBC_FAIL=-1} odbc_status;
35
36 /*! \brief ODBC container */
37 struct odbc_obj {
38         ast_mutex_t lock;
39         SQLHDBC  con;                   /* ODBC Connection Handle */
40         struct odbc_class *parent;      /* Information about the connection is protected */
41         struct timeval last_used;
42         unsigned int used:1;
43         unsigned int up:1;
44         AST_LIST_ENTRY(odbc_obj) list;
45 };
46
47 /* functions */
48
49 /*! 
50  * \brief Executes a prepared statement handle
51  * \param obj The non-NULL result of odbc_request_obj()
52  * \param stmt The prepared statement handle
53  * \retval 0 on success
54  * \retval -1 on failure
55  *
56  * This function was originally designed simply to execute a prepared
57  * statement handle and to retry if the initial execution failed.
58  * Unfortunately, it did this by disconnecting and reconnecting the database
59  * handle which on most databases causes the statement handle to become
60  * invalid.  Therefore, this method has been deprecated in favor of
61  * odbc_prepare_and_execute() which allows the statement to be prepared
62  * multiple times, if necessary, in case of a loss of connection.
63  *
64  * This function really only ever worked with MySQL, where the statement handle is
65  * not prepared on the server.  If you are not using MySQL, you should avoid it.
66  */
67 int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt) __attribute__ ((deprecated));
68
69 /*! 
70  * \brief Retrieves a connected ODBC object
71  * \param name The name of the ODBC class for which a connection is needed.
72  * \param check Whether to ensure that a connection is valid before returning the handle.  Usually unnecessary.
73  * \retval ODBC object 
74  * \retval  NULL if there is no connection available with the requested name.
75  *
76  * Connection classes may, in fact, contain multiple connection handles.  If
77  * the connection is pooled, then each connection will be dedicated to the
78  * thread which requests it.  Note that all connections should be released
79  * when the thread is done by calling odbc_release_obj(), below.
80  */
81 struct odbc_obj *ast_odbc_request_obj(const char *name, int check);
82
83 /*! 
84  * \brief Releases an ODBC object previously allocated by odbc_request_obj()
85  * \param obj The ODBC object
86  */
87 void ast_odbc_release_obj(struct odbc_obj *obj);
88
89 /*! 
90  * \brief Checks an ODBC object to ensure it is still connected
91  * \param obj The ODBC object
92  * \retval 0 if connected
93  * \retval -1 otherwise.
94  */
95 int ast_odbc_sanity_check(struct odbc_obj *obj);
96
97 /*! \brief Checks if the database natively supports backslash as an escape character.
98  * \param obj The ODBC object
99  * \return Returns 1 if backslash is a native escape character, 0 if an ESCAPE clause is needed to support '\'
100  */
101 int ast_odbc_backslash_is_escape(struct odbc_obj *obj);
102
103 /*! \brief Executes an non prepared statement and returns the resulting
104  * statement handle.
105  * \param obj The ODBC object
106  * \param exec_cb A function callback, which, when called, should return a statement handle with result columns bound.
107  * \param data A parameter to be passed to the exec_cb parameter function, indicating which statement handle is to be prepared.
108  * \retval a statement handle
109  * \retval NULL on error
110  */
111 SQLHSTMT ast_odbc_direct_execute(struct odbc_obj *obj, SQLHSTMT (*exec_cb)(struct odbc_obj *obj, void *data), void *data);
112
113 /*! 
114  * \brief Prepares, executes, and returns the resulting statement handle.
115  * \param obj The ODBC object
116  * \param prepare_cb A function callback, which, when called, should return a statement handle prepared, with any necessary parameters or result columns bound.
117  * \param data A parameter to be passed to the prepare_cb parameter function, indicating which statement handle is to be prepared.
118  * \retval a statement handle 
119  * \retval NULL on error
120  */
121 SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_cb)(struct odbc_obj *obj, void *data), void *data);
122
123 #endif /* _ASTERISK_RES_ODBC_H */