Connection Declarations for Clients

Macros
#define	DRIZZLE_SHUTDOWN_DEFAULT   0

Functions
drizzle_return_t	drizzle_con_connect (drizzle_con_st *con)
drizzle_result_st *	drizzle_con_quit (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_quit (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_con_select_db (drizzle_con_st *con, drizzle_result_st *result, const char *db, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_select_db (drizzle_con_st *con, drizzle_result_st *result, const char *db, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_con_shutdown (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_shutdown (drizzle_con_st *con, drizzle_result_st *result, uint32_t level, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_con_ping (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
drizzle_result_st *	drizzle_ping (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
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)

Detailed Description

Macro Definition Documentation

DRIZZLE_SHUTDOWN_DEFAULT

#define DRIZZLE_SHUTDOWN_DEFAULT   0

Todo

Remove this with next major API change.

Definition at line 106 of file conn_client.h.

Function Documentation

drizzle_con_connect()

drizzle_return_t drizzle_con_connect

(

drizzle_con_st *

con

)

Connect to server.

Parameters

[in]

con

Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.

Returns

Standard drizzle return value.

Definition at line 352 of file conn.c.

drizzle_con_quit()

drizzle_result_st * drizzle_con_quit	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		drizzle_return_t *	ret_ptr )

Send quit command to server for a connection.

Parameters

[in]	con	Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]	result	Caller allocated structure, or NULL to allocate one.
[out]	ret_ptr	Standard drizzle return value.

Returns

On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.

Definition at line 372 of file conn.c.

drizzle_quit()

drizzle_result_st * drizzle_quit	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		drizzle_return_t *	ret_ptr )

Todo

Remove this with next major API change.

Definition at line 380 of file conn.c.

drizzle_con_select_db()

drizzle_result_st * drizzle_con_select_db	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		const char *	db,
		drizzle_return_t *	ret_ptr )

Select a new default database for a connection.

Parameters

[in]	con	Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]	result	Caller allocated structure, or NULL to allocate one.
[in]	db	Default database to select.
[out]	ret_ptr	Standard drizzle return value.

Returns

On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.

Definition at line 387 of file conn.c.

drizzle_select_db()

drizzle_result_st * drizzle_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.

Definition at line 397 of file conn.c.

drizzle_con_shutdown()

drizzle_result_st * drizzle_con_shutdown	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		drizzle_return_t *	ret_ptr )

Send a shutdown message to the server.

Parameters

[in]	con	Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]	result	Caller allocated structure, or NULL to allocate one.
[out]	ret_ptr	Standard drizzle return value.

Returns

On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.

Definition at line 405 of file conn.c.

drizzle_shutdown()

drizzle_result_st * drizzle_shutdown	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		uint32_t	level,
		drizzle_return_t *	ret_ptr )

Definition at line 419 of file conn.c.

drizzle_con_ping()

drizzle_result_st * drizzle_con_ping	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		drizzle_return_t *	ret_ptr )

Send a ping request to the server.

Parameters

[in]	con	Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]	result	Caller allocated structure, or NULL to allocate one.
[out]	ret_ptr	Standard drizzle return value.

Returns

On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.

Definition at line 427 of file conn.c.

drizzle_ping()

drizzle_result_st * drizzle_ping	(	drizzle_con_st *	con,
		drizzle_result_st *	result,
		drizzle_return_t *	ret_ptr )

Todo

Remove this with next major API change.

Definition at line 435 of file conn.c.

drizzle_con_command_write()

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 )

Send raw command to server, possibly in parts.

Parameters

[in]	con	Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]	result	Caller allocated structure, or NULL to allocate one.
[in]	command	Command to run on server.
[in]	data	Data to send along with the command.
[in]	size	Size of the current chunk of data being sent.
[in]	total	Total size of all data being sent for command.
[out]	ret_ptr	Standard drizzle return value.

Returns

On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.

Definition at line 442 of file conn.c.