move ODBC API into ast_ namespace
[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 struct odbc_obj {
37         ast_mutex_t lock;
38         SQLHDBC  con;                   /* ODBC Connection Handle */
39         struct odbc_class *parent;      /* Information about the connection is protected */
40         unsigned int used:1;
41         unsigned int up:1;
42         AST_LIST_ENTRY(odbc_obj) list;
43 };
44
45 /* functions */
46
47 /*! \brief Executes a prepared statement handle
48  * \param obj The non-NULL result of odbc_request_obj()
49  * \param stmt The prepared statement handle
50  * \return Returns 0 on success or -1 on failure
51  *
52  * This function was originally designed simply to execute a prepared
53  * statement handle and to retry if the initial execution failed.
54  * Unfortunately, it did this by disconnecting and reconnecting the database
55  * handle which on most databases causes the statement handle to become
56  * invalid.  Therefore, this method has been deprecated in favor of
57  * odbc_prepare_and_execute() which allows the statement to be prepared
58  * multiple times, if necessary, in case of a loss of connection.
59  *
60  * This function really only ever worked with MySQL, where the statement handle is
61  * not prepared on the server.  If you are not using MySQL, you should avoid it.
62  */
63 int ast_odbc_smart_execute(struct odbc_obj *obj, SQLHSTMT stmt); /* DEPRECATED */
64
65 /*! \brief Retrieves a connected ODBC object
66  * \param name The name of the ODBC class for which a connection is needed.
67  * \param check Whether to ensure that a connection is valid before returning the handle.  Usually unnecessary.
68  * \return Returns an ODBC object or NULL if there is no connection available with the requested name.
69  *
70  * Connection classes may, in fact, contain multiple connection handles.  If
71  * the connection is pooled, then each connection will be dedicated to the
72  * thread which requests it.  Note that all connections should be released
73  * when the thread is done by calling odbc_release_obj(), below.
74  */
75 struct odbc_obj *ast_odbc_request_obj(const char *name, int check);
76
77 /*! \brief Releases an ODBC object previously allocated by odbc_request_obj()
78  * \param obj The ODBC object
79  */
80 void ast_odbc_release_obj(struct odbc_obj *obj);
81
82 /*! \brief Checks an ODBC object to ensure it is still connected
83  * \param obj The ODBC object
84  * \return Returns 0 if connected, -1 otherwise.
85  */
86 int ast_odbc_sanity_check(struct odbc_obj *obj);
87
88 /*! \brief Prepares, executes, and returns the resulting statement handle.
89  * \param obj The ODBC object
90  * \param prepare_cb A function callback, which, when called, should return a statement handle prepared, with any necessary parameters or result columns bound.
91  * \param data A parameter to be passed to the prepare_cb parameter function, indicating which statement handle is to be prepared.
92  * \return Returns a statement handle or NULL on error.
93  */
94 SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_cb)(struct odbc_obj *obj, void *data), void *data);
95
96 #endif /* _ASTERISK_RES_ODBC_H */