libdrizzle Public API Documentation

drizzle.h
Go to the documentation of this file.
1 /*
2  * Drizzle Client & Protocol Library
3  *
4  * Copyright (C) 2008 Eric Day (eday@oddments.org)
5  * All rights reserved.
6  *
7  * Use and distribution licensed under the BSD license. See
8  * the COPYING file in this directory for full text.
9  */
10 
16 #ifndef __DRIZZLE_H
17 #define __DRIZZLE_H
18 
19 #if !defined(__cplusplus) && !defined(_WIN32)
20 # include <stdbool.h>
21 #endif
22 
23 #include <inttypes.h>
24 #include <sys/types.h>
25 
26 #ifdef _WIN32
27 # include <winsock2.h>
28 # include <Ws2tcpip.h>
29 #else
30 # include <sys/socket.h>
31 # include <netinet/in.h>
32 # include <arpa/inet.h>
33 # include <sys/un.h>
34 # include <netdb.h>
35 # include <poll.h>
36 #endif
37 
38 #include <libdrizzle/visibility.h>
39 #include <libdrizzle/constants.h>
40 #include <libdrizzle/structs.h>
41 #include <libdrizzle/conn.h>
42 #include <libdrizzle/result.h>
43 #include <libdrizzle/column.h>
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
68 DRIZZLE_API
69 const char *drizzle_version(void);
70 
76 DRIZZLE_API
77 const char *drizzle_bugreport(void);
78 
85 DRIZZLE_API
86 const char *drizzle_verbose_name(drizzle_verbose_t verbose);
87 
96 DRIZZLE_API
98 
106 DRIZZLE_API
107 drizzle_st *drizzle_clone(drizzle_st *drizzle, const drizzle_st *from);
108 
115 DRIZZLE_API
116 void drizzle_free(drizzle_st *drizzle);
117 
125 DRIZZLE_API
126 const char *drizzle_error(const drizzle_st *drizzle);
127 
135 DRIZZLE_API
136 int drizzle_errno(const drizzle_st *drizzle);
137 
145 DRIZZLE_API
146 uint16_t drizzle_error_code(const drizzle_st *drizzle);
147 
155 DRIZZLE_API
156 const char *drizzle_sqlstate(const drizzle_st *drizzle);
157 
165 DRIZZLE_API
167 
175 DRIZZLE_API
176 void drizzle_set_options(drizzle_st *drizzle, drizzle_options_t options);
177 
185 DRIZZLE_API
186 void drizzle_add_options(drizzle_st *drizzle, drizzle_options_t options);
187 
195 DRIZZLE_API
196 void drizzle_remove_options(drizzle_st *drizzle, drizzle_options_t options);
197 
205 DRIZZLE_API
206 void *drizzle_context(const drizzle_st *drizzle);
207 
215 DRIZZLE_API
216 void drizzle_set_context(drizzle_st *drizzle, void *context);
217 
226 DRIZZLE_API
228  drizzle_context_free_fn *function);
229 
238 DRIZZLE_API
239 int drizzle_timeout(const drizzle_st *drizzle);
240 
249 DRIZZLE_API
250 void drizzle_set_timeout(drizzle_st *drizzle, int timeout);
251 
259 DRIZZLE_API
261 
271 DRIZZLE_API
272 void drizzle_set_verbose(drizzle_st *drizzle, drizzle_verbose_t verbose);
273 
284 DRIZZLE_API
285 void drizzle_set_log_fn(drizzle_st *drizzle, drizzle_log_fn *function,
286  void *context);
287 
303 DRIZZLE_API
305  drizzle_event_watch_fn *function,
306  void *context);
307 
319 DRIZZLE_API
321 
331 DRIZZLE_API
333  const drizzle_con_st *from);
334 
341 DRIZZLE_API
343 
350 DRIZZLE_API
351 void drizzle_con_free_all(drizzle_st *drizzle);
352 
360 DRIZZLE_API
362 
370 DRIZZLE_API
372 
375 #ifdef __cplusplus
376 }
377 #endif
378 
379 #endif /* __DRIZZLE_H */