d04aa79fa6cb4ec8722c7a68e98186a9cb981d88
[strongswan.git] / src / libstrongswan / plugins / mysql / mysql_database.h
1 /*
2 * Copyright (C) 2007-2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup mysql_database mysql_database
18 * @{ @ingroup mysql_p
19 */
20
21 #ifndef MYSQL_DATABASE_H_
22 #define MYSQL_DATABASE_H_
23
24 #include <database/database.h>
25
26 typedef struct mysql_database_t mysql_database_t;
27
28 /**
29 * MySQL databse_t implementation.
30 */
31 struct mysql_database_t {
32
33 /**
34 * Implements database_t
35 */
36 database_t db;
37 };
38
39 /**
40 * Create a mysql_database instance.
41 *
42 * @param uri connection URI, mysql://user:pass@host:port/database
43 */
44 mysql_database_t *mysql_database_create(char *uri);
45
46 /**
47 * MySQL client library initialization function
48 *
49 * @return FALSE if initialization failed
50 */
51 bool mysql_database_init();
52
53 /**
54 * Mysql client library cleanup function
55 */
56 void mysql_database_deinit();
57
58 #endif /* MYSQL_DATABASE_H_ @}*/