1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/*
* Drizzle Client & Protocol Library
*
* Copyright (C) 2008 Eric Day (eday@oddments.org)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * The names of its contributors may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/**
* @file
* @brief Connection Declarations for Clients
*/
#ifndef __DRIZZLE_CON_CLIENT_H
#define __DRIZZLE_CON_CLIENT_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup drizzle_con_client Connection Declarations for Clients
* @ingroup drizzle_client_interface
* @{
*/
/**
* Connect to server.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @return Standard drizzle return value.
*/
DRIZZLE_API
drizzle_return_t drizzle_con_connect(drizzle_con_st *con);
/**
* Send quit command to server for a connection.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @param[in] result Caller allocated structure, or NULL to allocate one.
* @param[out] ret_ptr Standard drizzle return value.
* @return On success, a pointer to the (possibly allocated) structure. On
* failure this will be NULL.
*/
DRIZZLE_API
drizzle_result_st *drizzle_con_quit(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* @todo Remove this with next major API change.
*/
DRIZZLE_API
drizzle_result_st *drizzle_quit(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* Select a new default database for a connection.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @param[in] result Caller allocated structure, or NULL to allocate one.
* @param[in] db Default database to select.
* @param[out] ret_ptr Standard drizzle return value.
* @return On success, a pointer to the (possibly allocated) structure. On
* failure this will be NULL.
*/
DRIZZLE_API
drizzle_result_st *drizzle_con_select_db(drizzle_con_st *con,
drizzle_result_st *result,
const char *db,
drizzle_return_t *ret_ptr);
/**
* @todo Remove this with next major API change.
*/
DRIZZLE_API
drizzle_result_st *drizzle_select_db(drizzle_con_st *con,
drizzle_result_st *result,
const char *db,
drizzle_return_t *ret_ptr);
/**
* Send a shutdown message to the server.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @param[in] result Caller allocated structure, or NULL to allocate one.
* @param[out] ret_ptr Standard drizzle return value.
* @return On success, a pointer to the (possibly allocated) structure. On
* failure this will be NULL.
*/
DRIZZLE_API
drizzle_result_st *drizzle_con_shutdown(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* @todo Remove this with next major API change.
*/
#define DRIZZLE_SHUTDOWN_DEFAULT 0
DRIZZLE_API
drizzle_result_st *drizzle_shutdown(drizzle_con_st *con,
drizzle_result_st *result, uint32_t level,
drizzle_return_t *ret_ptr);
/**
* Send a ping request to the server.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @param[in] result Caller allocated structure, or NULL to allocate one.
* @param[out] ret_ptr Standard drizzle return value.
* @return On success, a pointer to the (possibly allocated) structure. On
* failure this will be NULL.
*/
DRIZZLE_API
drizzle_result_st *drizzle_con_ping(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* @todo Remove this with next major API change.
*/
DRIZZLE_API
drizzle_result_st *drizzle_ping(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* Send raw command to server, possibly in parts.
*
* @param[in] con Connection structure previously initialized with
* drizzle_con_create(), drizzle_con_clone(), or related functions.
* @param[in] result Caller allocated structure, or NULL to allocate one.
* @param[in] command Command to run on server.
* @param[in] data Data to send along with the command.
* @param[in] size Size of the current chunk of data being sent.
* @param[in] total Total size of all data being sent for command.
* @param[out] ret_ptr Standard drizzle return value.
* @return On success, a pointer to the (possibly allocated) structure. On
* failure this will be NULL.
*/
DRIZZLE_API
drizzle_result_st *drizzle_con_command_write(drizzle_con_st *con,
drizzle_result_st *result,
drizzle_command_t command,
const void *data, size_t size,
size_t total,
drizzle_return_t *ret_ptr);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* __DRIZZLE_CON_CLIENT_H */
|