~drizzle-trunk/drizzle/development : contents of libdrizzle-2.0/conn.h at revision 2476

~drizzle-trunk/drizzle/development : (revision 2476)

/*
 * 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.
 *
 */

#pragma once

/**
 * @file
 * @brief Connection Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup drizzle_con Connection Declarations
 * @ingroup drizzle_client_interface
 * @ingroup drizzle_server_interface
 * @{
 */

/**
 * Get file descriptor for connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return File descriptor of connection, or -1 if not active.
 */
DRIZZLE_API
int drizzle_con_fd(const drizzle_con_st *con);

/**
 * Use given file descriptor for connction.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] fd File descriptor for connection.
 * @return Standard drizzle return value.
 */
DRIZZLE_API
drizzle_return_t drizzle_con_set_fd(drizzle_con_st *con, int fd);

/**
 * Close a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 */
DRIZZLE_API
void drizzle_con_close(drizzle_con_st *con);

/**
 * Set events to be watched for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] events Bitfield of poll() events to watch.
 * @return Standard drizzle return value.
 */
DRIZZLE_API
drizzle_return_t drizzle_con_set_events(drizzle_con_st *con, short events);

/**
 * Set events that are ready for a connection. This is used with the external
 * event callbacks. See drizzle_set_event_watch_fn().
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] revents Bitfield of poll() events that were detected.
 * @return Standard drizzle return value.
 */
DRIZZLE_API
drizzle_return_t drizzle_con_set_revents(drizzle_con_st *con, short revents);

/**
 * Get the drizzle_st struct that the connection belongs to.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Drizzle object that this connection is part of.
 */
DRIZZLE_API
drizzle_st *drizzle_con_drizzle(const drizzle_con_st *con);

/**
 * Return an error string for last error encountered.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Pointer to static buffer in library that holds an error string.
 */
DRIZZLE_API
const char *drizzle_con_error(const drizzle_con_st *con);

/**
 * Value of errno in the case of a DRIZZLE_RETURN_ERRNO return value.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return An errno value as defined in your system errno.h file.
 */
DRIZZLE_API
int drizzle_con_errno(const drizzle_con_st *con);

/**
 * Get server defined error code for the last result read.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return An error code given back in the server response.
 */
DRIZZLE_API
uint16_t drizzle_con_error_code(const drizzle_con_st *con);

/**
 * Get SQL state code for the last result read.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return A SQLSTATE code given back in the server response.
 */
DRIZZLE_API
const char *drizzle_con_sqlstate(const drizzle_con_st *con);

/**
 * Get options for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Options set for the connection structure.
 */
DRIZZLE_API
int drizzle_con_options(const drizzle_con_st *con);

/**
 * Set options for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] options Available options for connection structure to set.
 */
DRIZZLE_API
void drizzle_con_set_options(drizzle_con_st *con,
                             int options);

/**
 * Add options for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] options Available options for connection structure to set.
 */
DRIZZLE_API
void drizzle_con_add_options(drizzle_con_st *con,
                             int options);

/**
 * Remove options for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] options Available options for connection structure to remove.
 */
DRIZZLE_API
void drizzle_con_remove_options(drizzle_con_st *con,
                                int options);

/**
 * Get TCP host for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Host this connection is configured for, or NULL if not set.
 */
DRIZZLE_API
const char *drizzle_con_host(const drizzle_con_st *con);

/**
 * Get TCP port for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Port this connection is configured for, 0 if not set.
 */
DRIZZLE_API
in_port_t drizzle_con_port(const drizzle_con_st *con);

/**
 * Set TCP host and port for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] host Host to use for this connection, NULL for default value.
 * @param[in] port Port to use for this connection, 0 for default value.
 */
DRIZZLE_API
void drizzle_con_set_tcp(drizzle_con_st *con, const char *host, in_port_t port);

/**
 * Get unix domain socket for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Unix domain socket set for this connection, NULL if not set.
 */
DRIZZLE_API
const char *drizzle_con_uds(const drizzle_con_st *con);

/**
 * Set unix domain socket for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] uds Unix domain socket to use for this connection, NULL for
 *  defailt value.
 */
DRIZZLE_API
void drizzle_con_set_uds(drizzle_con_st *con, const char *uds);

/**
 * Get username for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return User associated with this connection.
 */
DRIZZLE_API
const char *drizzle_con_user(const drizzle_con_st *con);

/**
 * Get password for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Password associated with this connection.
 */
DRIZZLE_API
const char *drizzle_con_password(const drizzle_con_st *con);

/**
 * Set username and password for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] user Username to use for this connection.
 * @param[in] password Password to use for this connection.
 */
DRIZZLE_API
void drizzle_con_set_auth(drizzle_con_st *con, const char *user,
                          const char *password);

/**
 * Get database for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Database associated with this connection.
 */
DRIZZLE_API
const char *drizzle_con_schema(const drizzle_con_st *con);

DRIZZLE_API
const char *drizzle_con_db(const drizzle_con_st *con);

/**
 * Set database for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] schema Database to use with this connection.
 */
DRIZZLE_API
void drizzle_con_set_schema(drizzle_con_st *con, const char *schema);

DRIZZLE_API
void drizzle_con_set_db(drizzle_con_st *con, const char *schema);

/**
 * Get application context pointer for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Application context with this connection.
 */
DRIZZLE_API
void *drizzle_con_context(const drizzle_con_st *con);

/**
 * Set application context pointer for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] context Application context to use with this connection.
 */
DRIZZLE_API
void drizzle_con_set_context(drizzle_con_st *con, void *context);

/**
 * Set callback function when the context pointer should be freed.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] function Function to call to clean up connection context.
 */
DRIZZLE_API
void drizzle_con_set_context_free_fn(drizzle_con_st *con,
                                     drizzle_con_context_free_fn *function);

/**
 * Get protocol version for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Protocol version for connection.
 */
DRIZZLE_API
uint8_t drizzle_con_protocol_version(const drizzle_con_st *con);

/**
 * Get server version string for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Server version string for connection.
 */
DRIZZLE_API
const char *drizzle_con_server_version(const drizzle_con_st *con);

/**
 * Get server version number for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Server version number for connection.
 */
DRIZZLE_API
uint32_t drizzle_con_server_version_number(const drizzle_con_st *con);

/**
 * Get thread ID for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Thread ID for connection.
 */
DRIZZLE_API
uint32_t drizzle_con_thread_id(const drizzle_con_st *con);

/**
 * Get scramble buffer for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Scramble buffer for connection.
 */
DRIZZLE_API
const uint8_t *drizzle_con_scramble(const drizzle_con_st *con);

/**
 * Get capabilities for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Capabilities for connection.
 */
DRIZZLE_API
int drizzle_con_capabilities(const drizzle_con_st *con);

/**
 * Get character set for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Character set for connection.
 */
DRIZZLE_API
drizzle_charset_t drizzle_con_charset(const drizzle_con_st *con);

/**
 * Get status for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Status for connection.
 */
DRIZZLE_API
drizzle_con_status_t drizzle_con_status(const drizzle_con_st *con);

/**
 * Get max packet size for a connection.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return Max packet size for connection.
 */
DRIZZLE_API
uint32_t drizzle_con_max_packet_size(const drizzle_con_st *con);

/** @} */

#ifdef __cplusplus
}
#endif

2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	1	/*
	2	* Drizzle Client & Protocol Library
	3	*
	4	* Copyright (C) 2008 Eric Day (eday@oddments.org)
	5	* All rights reserved.
	6	*
	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions are
	9	* met:
	10	*
	11	* * Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	*
	14	* * Redistributions in binary form must reproduce the above
	15	* copyright notice, this list of conditions and the following disclaimer
	16	* in the documentation and/or other materials provided with the
	17	* distribution.
	18	*
	19	* * The names of its contributors may not be used to endorse or
	20	* promote products derived from this software without specific prior
	21	* written permission.
	22	*
	23	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	24	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	25	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	26	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	27	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	28	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	29	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	30	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	31	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	32	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	33	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	34	*
	35	*/
	36
2449.1.4 by Brian Aker Complete update of libdrizzle	37	#pragma once
2449.1.4 by Brian Aker Complete update of libdrizzle	38
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	39	/**
	40	* @file
	41	* @brief Connection Declarations
	42	*/
	43
	44	#ifdef __cplusplus
	45	extern "C" {
	46	#endif
	47
	48	/**
	49	* @addtogroup drizzle_con Connection Declarations
	50	* @ingroup drizzle_client_interface
	51	* @ingroup drizzle_server_interface
	52	* @{
	53	*/
	54
	55	/**
	56	* Get file descriptor for connection.
	57	*
	58	* @param[in] con Connection structure previously initialized with
	59	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	60	* @return File descriptor of connection, or -1 if not active.
	61	*/
	62	DRIZZLE_API
	63	int drizzle_con_fd(const drizzle_con_st *con);
	64
	65	/**
	66	* Use given file descriptor for connction.
	67	*
	68	* @param[in] con Connection structure previously initialized with
	69	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	70	* @param[in] fd File descriptor for connection.
	71	* @return Standard drizzle return value.
	72	*/
	73	DRIZZLE_API
	74	drizzle_return_t drizzle_con_set_fd(drizzle_con_st *con, int fd);
	75
	76	/**
	77	* Close a connection.
	78	*
	79	* @param[in] con Connection structure previously initialized with
	80	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	81	*/
	82	DRIZZLE_API
	83	void drizzle_con_close(drizzle_con_st *con);
	84
	85	/**
	86	* Set events to be watched for a connection.
	87	*
	88	* @param[in] con Connection structure previously initialized with
	89	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	90	* @param[in] events Bitfield of poll() events to watch.
	91	* @return Standard drizzle return value.
	92	*/
	93	DRIZZLE_API
	94	drizzle_return_t drizzle_con_set_events(drizzle_con_st *con, short events);
	95
	96	/**
	97	* Set events that are ready for a connection. This is used with the external
	98	* event callbacks. See drizzle_set_event_watch_fn().
	99	*
	100	* @param[in] con Connection structure previously initialized with
	101	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	102	* @param[in] revents Bitfield of poll() events that were detected.
103	* @return Standard drizzle return value.
104	*/
105	DRIZZLE_API
106	drizzle_return_t drizzle_con_set_revents(drizzle_con_st *con, short revents);
107
108	/**
109	* Get the drizzle_st struct that the connection belongs to.
110	*
111	* @param[in] con Connection structure previously initialized with
112	* drizzle_con_create(), drizzle_con_clone(), or related functions.
113	* @return Drizzle object that this connection is part of.
114	*/
115	DRIZZLE_API
116	drizzle_st drizzle_con_drizzle(const drizzle_con_st con);
117
118	/**
119	* Return an error string for last error encountered.
120	*
121	* @param[in] con Connection structure previously initialized with
122	* drizzle_con_create(), drizzle_con_clone(), or related functions.
123	* @return Pointer to static buffer in library that holds an error string.
124	*/
125	DRIZZLE_API
126	const char drizzle_con_error(const drizzle_con_st con);
127
128	/**
129	* Value of errno in the case of a DRIZZLE_RETURN_ERRNO return value.
130	*
131	* @param[in] con Connection structure previously initialized with
132	* drizzle_con_create(), drizzle_con_clone(), or related functions.
133	* @return An errno value as defined in your system errno.h file.
134	*/
135	DRIZZLE_API
136	int drizzle_con_errno(const drizzle_con_st *con);
137
138	/**
139	* Get server defined error code for the last result read.
140	*
141	* @param[in] con Connection structure previously initialized with
142	* drizzle_con_create(), drizzle_con_clone(), or related functions.
143	* @return An error code given back in the server response.
144	*/
145	DRIZZLE_API
146	uint16_t drizzle_con_error_code(const drizzle_con_st *con);
147
148	/**
149	* Get SQL state code for the last result read.
150	*
151	* @param[in] con Connection structure previously initialized with
152	* drizzle_con_create(), drizzle_con_clone(), or related functions.
153	* @return A SQLSTATE code given back in the server response.
154	*/
155	DRIZZLE_API
156	const char drizzle_con_sqlstate(const drizzle_con_st con);
157
158	/**
159	* Get options for a connection.
160	*
161	* @param[in] con Connection structure previously initialized with
162	* drizzle_con_create(), drizzle_con_clone(), or related functions.
163	* @return Options set for the connection structure.
164	*/
165	DRIZZLE_API
166	int drizzle_con_options(const drizzle_con_st *con);
167
168	/**
169	* Set options for a connection.
170	*
171	* @param[in] con Connection structure previously initialized with
172	* drizzle_con_create(), drizzle_con_clone(), or related functions.
173	* @param[in] options Available options for connection structure to set.
174	*/
175	DRIZZLE_API
176	void drizzle_con_set_options(drizzle_con_st *con,
177	int options);
178
179	/**
180	* Add options for a connection.
181	*
182	* @param[in] con Connection structure previously initialized with
183	* drizzle_con_create(), drizzle_con_clone(), or related functions.
184	* @param[in] options Available options for connection structure to set.
185	*/
186	DRIZZLE_API
187	void drizzle_con_add_options(drizzle_con_st *con,
188	int options);
189
190	/**
191	* Remove options for a connection.
192	*
193	* @param[in] con Connection structure previously initialized with
194	* drizzle_con_create(), drizzle_con_clone(), or related functions.
195	* @param[in] options Available options for connection structure to remove.
196	*/
197	DRIZZLE_API
198	void drizzle_con_remove_options(drizzle_con_st *con,
199	int options);
200
201	/**
202	* Get TCP host for a connection.
203	*
204	* @param[in] con Connection structure previously initialized with
205	* drizzle_con_create(), drizzle_con_clone(), or related functions.
206	* @return Host this connection is configured for, or NULL if not set.
207	*/
208	DRIZZLE_API
209	const char drizzle_con_host(const drizzle_con_st con);
210
211	/**
212	* Get TCP port for a connection.
213	*
214	* @param[in] con Connection structure previously initialized with
215	* drizzle_con_create(), drizzle_con_clone(), or related functions.
216	* @return Port this connection is configured for, 0 if not set.
217	*/
218	DRIZZLE_API
219	in_port_t drizzle_con_port(const drizzle_con_st *con);
220
221	/**
222	* Set TCP host and port for a connection.
223	*
224	* @param[in] con Connection structure previously initialized with
225	* drizzle_con_create(), drizzle_con_clone(), or related functions.
226	* @param[in] host Host to use for this connection, NULL for default value.
227	* @param[in] port Port to use for this connection, 0 for default value.
228	*/
229	DRIZZLE_API
230	void drizzle_con_set_tcp(drizzle_con_st con, const char host, in_port_t port);
231
232	/**
233	* Get unix domain socket for a connection.
234	*
235	* @param[in] con Connection structure previously initialized with
236	* drizzle_con_create(), drizzle_con_clone(), or related functions.
237	* @return Unix domain socket set for this connection, NULL if not set.
238	*/
239	DRIZZLE_API
240	const char drizzle_con_uds(const drizzle_con_st con);
241
242	/**
243	* Set unix domain socket for a connection.
244	*
245	* @param[in] con Connection structure previously initialized with
246	* drizzle_con_create(), drizzle_con_clone(), or related functions.
247	* @param[in] uds Unix domain socket to use for this connection, NULL for
248	* defailt value.
249	*/
250	DRIZZLE_API
251	void drizzle_con_set_uds(drizzle_con_st con, const char uds);
252
253	/**
254	* Get username for a connection.
255	*
256	* @param[in] con Connection structure previously initialized with
257	* drizzle_con_create(), drizzle_con_clone(), or related functions.
258	* @return User associated with this connection.
259	*/
260	DRIZZLE_API
261	const char drizzle_con_user(const drizzle_con_st con);
262
263	/**
264	* Get password for a connection.
265	*
266	* @param[in] con Connection structure previously initialized with
267	* drizzle_con_create(), drizzle_con_clone(), or related functions.
268	* @return Password associated with this connection.
269	*/
270	DRIZZLE_API
271	const char drizzle_con_password(const drizzle_con_st con);
272
273	/**
274	* Set username and password for a connection.
275	*
276	* @param[in] con Connection structure previously initialized with
277	* drizzle_con_create(), drizzle_con_clone(), or related functions.
278	* @param[in] user Username to use for this connection.
279	* @param[in] password Password to use for this connection.
280	*/
281	DRIZZLE_API
282	void drizzle_con_set_auth(drizzle_con_st con, const char user,
283	const char *password);
284
285	/**
286	* Get database for a connection.
287	*
288	* @param[in] con Connection structure previously initialized with
289	* drizzle_con_create(), drizzle_con_clone(), or related functions.
290	* @return Database associated with this connection.
291	*/
292	DRIZZLE_API
2461.1.1 by Brian Aker Fix safety issues around calling API with no check for NULL	293	const char drizzle_con_schema(const drizzle_con_st con);
	294
	295	DRIZZLE_API
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	296	const char drizzle_con_db(const drizzle_con_st con);
	297
	298	/**
	299	* Set database for a connection.
	300	*
	301	* @param[in] con Connection structure previously initialized with
	302	* drizzle_con_create(), drizzle_con_clone(), or related functions.
2461.1.1 by Brian Aker Fix safety issues around calling API with no check for NULL	303	* @param[in] schema Database to use with this connection.
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	304	*/
	305	DRIZZLE_API
2461.1.1 by Brian Aker Fix safety issues around calling API with no check for NULL	306	void drizzle_con_set_schema(drizzle_con_st con, const char schema);
	307
	308	DRIZZLE_API
	309	void drizzle_con_set_db(drizzle_con_st con, const char schema);
2244.1.1 by Monty Taylor Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.	310
	311	/**
	312	* Get application context pointer for a connection.
	313	*
	314	* @param[in] con Connection structure previously initialized with
	315	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	316	* @return Application context with this connection.
	317	*/
	318	DRIZZLE_API
	319	void drizzle_con_context(const drizzle_con_st con);
	320
	321	/**
	322	* Set application context pointer for a connection.
	323	*
	324	* @param[in] con Connection structure previously initialized with
	325	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	326	* @param[in] context Application context to use with this connection.
	327	*/
	328	DRIZZLE_API
	329	void drizzle_con_set_context(drizzle_con_st con, void context);
	330
	331	/**
	332	* Set callback function when the context pointer should be freed.
	333	*
	334	* @param[in] con Connection structure previously initialized with
	335	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	336	* @param[in] function Function to call to clean up connection context.
	337	*/
	338	DRIZZLE_API
	339	void drizzle_con_set_context_free_fn(drizzle_con_st *con,
	340	drizzle_con_context_free_fn *function);
	341
	342	/**
	343	* Get protocol version for a connection.
	344	*
	345	* @param[in] con Connection structure previously initialized with
	346	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	347	* @return Protocol version for connection.
	348	*/
	349	DRIZZLE_API
	350	uint8_t drizzle_con_protocol_version(const drizzle_con_st *con);
	351
	352	/**
	353	* Get server version string for a connection.
	354	*
	355	* @param[in] con Connection structure previously initialized with
	356	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	357	* @return Server version string for connection.
	358	*/
	359	DRIZZLE_API
	360	const char drizzle_con_server_version(const drizzle_con_st con);
	361
	362	/**
	363	* Get server version number for a connection.
	364	*
	365	* @param[in] con Connection structure previously initialized with
	366	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	367	* @return Server version number for connection.
	368	*/
	369	DRIZZLE_API
	370	uint32_t drizzle_con_server_version_number(const drizzle_con_st *con);
	371
	372	/**
	373	* Get thread ID for a connection.
374	*
375	* @param[in] con Connection structure previously initialized with
376	* drizzle_con_create(), drizzle_con_clone(), or related functions.
377	* @return Thread ID for connection.
378	*/
379	DRIZZLE_API
380	uint32_t drizzle_con_thread_id(const drizzle_con_st *con);
381
382	/**
383	* Get scramble buffer for a connection.
384	*
385	* @param[in] con Connection structure previously initialized with
386	* drizzle_con_create(), drizzle_con_clone(), or related functions.
387	* @return Scramble buffer for connection.
388	*/
389	DRIZZLE_API
390	const uint8_t drizzle_con_scramble(const drizzle_con_st con);
391
392	/**
393	* Get capabilities for a connection.
394	*
395	* @param[in] con Connection structure previously initialized with
396	* drizzle_con_create(), drizzle_con_clone(), or related functions.
397	* @return Capabilities for connection.
398	*/
399	DRIZZLE_API
400	int drizzle_con_capabilities(const drizzle_con_st *con);
401
402	/**
403	* Get character set for a connection.
404	*
405	* @param[in] con Connection structure previously initialized with
406	* drizzle_con_create(), drizzle_con_clone(), or related functions.
407	* @return Character set for connection.
408	*/
409	DRIZZLE_API
410	drizzle_charset_t drizzle_con_charset(const drizzle_con_st *con);
411
412	/**
413	* Get status for a connection.
414	*
415	* @param[in] con Connection structure previously initialized with
416	* drizzle_con_create(), drizzle_con_clone(), or related functions.
417	* @return Status for connection.
418	*/
419	DRIZZLE_API
420	drizzle_con_status_t drizzle_con_status(const drizzle_con_st *con);
421
422	/**
423	* Get max packet size for a connection.
424	*
425	* @param[in] con Connection structure previously initialized with
426	* drizzle_con_create(), drizzle_con_clone(), or related functions.
427	* @return Max packet size for connection.
428	*/
429	DRIZZLE_API
430	uint32_t drizzle_con_max_packet_size(const drizzle_con_st *con);
431
432	/** @} */
433
434	#ifdef __cplusplus
435	}
436	#endif