|
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
1 |
.. highlightlang:: c |
2 |
||
3 |
Library Object
|
|
4 |
--------------
|
|
5 |
||
6 |
.. index:: object: drizzle_st |
|
7 |
||
8 |
This is the core library structure that other structures (such as |
|
9 |
connections) are created from. |
|
10 |
||
11 |
There is no locking within a single drizzle_st structure, so for threaded |
|
12 |
applications you must either ensure isolation in the application or use |
|
13 |
multiple drizzle_st structures (for example, one for each thread). |
|
14 |
||
15 |
General Functions
|
|
16 |
^^^^^^^^^^^^^^^^^
|
|
17 |
||
18 |
.. c:function:: const char * drizzle_version (void) |
|
19 |
.. c:function:: const char * drizzle_bugreport (void) |
|
20 |
.. c:function:: const char * drizzle_verbose_name (drizzle_verbose_t verbose) |
|
21 |
.. c:function:: drizzle_st * drizzle_create (drizzle_st *drizzle) |
|
22 |
.. c:function:: drizzle_st * drizzle_clone (drizzle_st *drizzle, const drizzle_st *from) |
|
23 |
.. c:function:: void drizzle_free (drizzle_st *drizzle) |
|
24 |
.. c:function:: const char * drizzle_error (const drizzle_st *drizzle) |
|
25 |
.. c:function:: int drizzle_errno (const drizzle_st *drizzle) |
|
26 |
||
27 |
.. c:function:: uint16_t drizzle_error_code (const drizzle_st *drizzle) |
|
28 |
||
29 |
.. c:function:: const char * drizzle_sqlstate (const drizzle_st *drizzle) |
|
30 |
||
31 |
.. c:function:: drizzle_options_t drizzle_options (const drizzle_st *drizzle) |
|
32 |
||
33 |
.. c:function:: void drizzle_set_options (drizzle_st *drizzle, drizzle_options_t options) |
|
34 |
||
35 |
.. c:function:: void drizzle_add_options (drizzle_st *drizzle, drizzle_options_t options) |
|
36 |
||
37 |
.. c:function:: void drizzle_remove_options (drizzle_st *drizzle, drizzle_options_t options) |
|
38 |
||
39 |
.. c:function:: void * drizzle_context (const drizzle_st *drizzle) |
|
40 |
||
41 |
.. c:function:: void drizzle_set_context (drizzle_st *drizzle, void *context) |
|
42 |
||
43 |
.. c:function:: void drizzle_set_context_free_fn (drizzle_st *drizzle, |
|
44 |
||
45 |
.. c:function:: drizzle_context_free_fn *function) |
|
46 |
||
47 |
.. c:function:: int drizzle_timeout (const drizzle_st *drizzle) |
|
48 |
||
49 |
.. c:function:: void drizzle_set_timeout (drizzle_st *drizzle, int timeout) |
|
50 |
||
51 |
.. c:function:: drizzle_verbose_t drizzle_verbose (const drizzle_st *drizzle) |
|
52 |
||
53 |
.. c:function:: void drizzle_set_verbose (drizzle_st *drizzle, drizzle_verbose_t verbose) |
|
54 |
||
55 |
.. c:function:: void drizzle_set_log_fn (drizzle_st *drizzle, drizzle_log_fn *function, void *context) |
|
56 |
||
57 |
.. c:function:: void drizzle_set_event_watch_fn (drizzle_st *drizzle, |
|
58 |
||
59 |
.. c:function:: drizzle_event_watch_fn *function, void *context) |
|
60 |
||
61 |
.. c:function:: drizzle_con_st * drizzle_con_create (drizzle_st *drizzle, drizzle_con_st *con) |
|
62 |
||
63 |
.. c:function:: drizzle_con_st * drizzle_con_clone (drizzle_st *drizzle, drizzle_con_st *con, const drizzle_con_st *from) |
|
64 |
||
65 |
.. c:function:: void drizzle_con_free (drizzle_con_st *con) |
|
66 |
||
67 |
.. c:function:: void drizzle_con_free_all (drizzle_st *drizzle) |
|
68 |
||
69 |
.. c:function:: drizzle_return_t drizzle_con_wait (drizzle_st *drizzle) |
|
70 |
||
71 |
.. c:function:: drizzle_con_st * drizzle_con_ready (drizzle_st *drizzle) |
|
72 |
||
73 |
Functions for Client Only
|
|
74 |
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
75 |
||
76 |
.. c:function:: drizzle_con_st * drizzle_con_add_tcp (drizzle_st *drizzle, drizzle_con_st *con, const char *host, in_port_t port, const char *user, const char *password, const char *db, drizzle_con_options_t options) |
|
77 |
||
78 |
.. c:function:: drizzle_con_st * drizzle_con_add_uds (drizzle_st *drizzle, drizzle_con_st *con, const char *uds, const char *user, const char *password, const char *db, drizzle_con_options_t options) |
|
79 |
||
80 |
Functions for Server Only
|
|
81 |
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
82 |
||
83 |
.. c:function:: drizzle_con_st * drizzle_con_add_tcp_listen (drizzle_st *drizzle, drizzle_con_st *con, const char *host, in_port_t port, int backlog, drizzle_con_options_t options) |
|
84 |
||
85 |
.. c:function:: drizzle_con_st * drizzle_con_add_uds_listen (drizzle_st *drizzle, drizzle_con_st *con, const char *uds, int backlog, drizzle_con_options_t options) |
|
86 |
||
87 |
.. c:function:: drizzle_con_st * drizzle_con_ready_listen (drizzle_st *drizzle) |
|
88 |
||
89 |
.. c:function:: drizzle_con_st * drizzle_con_accept (drizzle_st *drizzle, drizzle_con_st *con, drizzle_return_t *ret_ptr) |