Connection Handling
[Drizzle Client Interface, Drizzle Server Interface]

Modules
	Private Connection Functions
Enumerations
enum	drizzle_con_options_t {   DRIZZLE_CON_NONE = 0, DRIZZLE_CON_ALLOCATED = (1 << 0), DRIZZLE_CON_MYSQL = (1 << 1), DRIZZLE_CON_RAW_PACKET = (1 << 2),   DRIZZLE_CON_RAW_SCRAMBLE = (1 << 3), DRIZZLE_CON_READY = (1 << 4), DRIZZLE_CON_NO_RESULT_READ = (1 << 5), DRIZZLE_CON_IO_READY = (1 << 6) }
enum	drizzle_con_status_t {   DRIZZLE_CON_STATUS_NONE = 0, DRIZZLE_CON_STATUS_IN_TRANS = (1 << 0), DRIZZLE_CON_STATUS_AUTOCOMMIT = (1 << 1), DRIZZLE_CON_STATUS_MORE_RESULTS_EXISTS = (1 << 3),   DRIZZLE_CON_STATUS_QUERY_NO_GOOD_INDEX_USED = (1 << 4), DRIZZLE_CON_STATUS_QUERY_NO_INDEX_USED = (1 << 5), DRIZZLE_CON_STATUS_CURSOR_EXISTS = (1 << 6), DRIZZLE_CON_STATUS_LAST_ROW_SENT = (1 << 7),   DRIZZLE_CON_STATUS_DB_DROPPED = (1 << 8), DRIZZLE_CON_STATUS_NO_BACKSLASH_ESCAPES = (1 << 9), DRIZZLE_CON_STATUS_QUERY_WAS_SLOW = (1 << 10) }
enum	drizzle_capabilities_t {   DRIZZLE_CAPABILITIES_NONE = 0, DRIZZLE_CAPABILITIES_LONG_PASSWORD = (1 << 0), DRIZZLE_CAPABILITIES_FOUND_ROWS = (1 << 1), DRIZZLE_CAPABILITIES_LONG_FLAG = (1 << 2),   DRIZZLE_CAPABILITIES_CONNECT_WITH_DB = (1 << 3), DRIZZLE_CAPABILITIES_NO_SCHEMA = (1 << 4), DRIZZLE_CAPABILITIES_COMPRESS = (1 << 5), DRIZZLE_CAPABILITIES_ODBC = (1 << 6),   DRIZZLE_CAPABILITIES_LOCAL_FILES = (1 << 7), DRIZZLE_CAPABILITIES_IGNORE_SPACE = (1 << 8), DRIZZLE_CAPABILITIES_PROTOCOL_41 = (1 << 9), DRIZZLE_CAPABILITIES_INTERACTIVE = (1 << 10),   DRIZZLE_CAPABILITIES_SSL = (1 << 11), DRIZZLE_CAPABILITIES_IGNORE_SIGPIPE = (1 << 12), DRIZZLE_CAPABILITIES_TRANSACTIONS = (1 << 13), DRIZZLE_CAPABILITIES_RESERVED = (1 << 14),   DRIZZLE_CAPABILITIES_SECURE_CONNECTION = (1 << 15), DRIZZLE_CAPABILITIES_MULTI_STATEMENTS = (1 << 16), DRIZZLE_CAPABILITIES_MULTI_RESULTS = (1 << 17), DRIZZLE_CAPABILITIES_SSL_VERIFY_SERVER_CERT = (1 << 30),   DRIZZLE_CAPABILITIES_REMEMBER_OPTIONS = (1 << 31), DRIZZLE_CAPABILITIES_CLIENT }
Functions
drizzle_con_st *	drizzle_con_create (drizzle_st *drizzle, drizzle_con_st *con)
drizzle_con_st *	drizzle_con_clone (drizzle_st *drizzle, drizzle_con_st *con, drizzle_con_st *from)
void	drizzle_con_free (drizzle_con_st *con)
int	drizzle_con_fd (drizzle_con_st *con)
drizzle_return_t	drizzle_con_set_fd (drizzle_con_st *con, int fd)
void	drizzle_con_close (drizzle_con_st *con)
drizzle_return_t	drizzle_con_wait (drizzle_st *drizzle)
drizzle_return_t	drizzle_con_set_events (drizzle_con_st *con, short events)
void	drizzle_con_set_revents (drizzle_con_st *con, short revents)
drizzle_con_st *	drizzle_con_ready (drizzle_st *drizzle)
drizzle_st *	drizzle_con_drizzle (drizzle_con_st *con)
const char *	drizzle_con_error (drizzle_con_st *con)
int	drizzle_con_errno (drizzle_con_st *con)
uint16_t	drizzle_con_error_code (drizzle_con_st *con)
const char *	drizzle_con_sqlstate (drizzle_con_st *con)
drizzle_con_options_t	drizzle_con_options (drizzle_con_st *con)
void	drizzle_con_set_options (drizzle_con_st *con, drizzle_con_options_t options)
void	drizzle_con_add_options (drizzle_con_st *con, drizzle_con_options_t options)
void	drizzle_con_remove_options (drizzle_con_st *con, drizzle_con_options_t options)
const char *	drizzle_con_host (drizzle_con_st *con)
in_port_t	drizzle_con_port (drizzle_con_st *con)
void	drizzle_con_set_tcp (drizzle_con_st *con, const char *host, in_port_t port)
const char *	drizzle_con_uds (drizzle_con_st *con)
void	drizzle_con_set_uds (drizzle_con_st *con, const char *uds)
const char *	drizzle_con_user (drizzle_con_st *con)
const char *	drizzle_con_password (drizzle_con_st *con)
void	drizzle_con_set_auth (drizzle_con_st *con, const char *user, const char *password)
const char *	drizzle_con_db (drizzle_con_st *con)
void	drizzle_con_set_db (drizzle_con_st *con, const char *db)
void *	drizzle_con_data (drizzle_con_st *con)
void	drizzle_con_set_data (drizzle_con_st *con, const void *data)
void	drizzle_con_set_data_free (drizzle_con_st *con, drizzle_con_data_free_fn *free_fn)
uint8_t	drizzle_con_protocol_version (drizzle_con_st *con)
const char *	drizzle_con_server_version (drizzle_con_st *con)
uint32_t	drizzle_con_server_version_number (drizzle_con_st *con)
uint32_t	drizzle_con_thread_id (drizzle_con_st *con)
const uint8_t *	drizzle_con_scramble (drizzle_con_st *con)
drizzle_capabilities_t	drizzle_con_capabilities (drizzle_con_st *con)
drizzle_charset_t	drizzle_con_charset (drizzle_con_st *con)
drizzle_con_status_t	drizzle_con_status (drizzle_con_st *con)
uint32_t	drizzle_con_max_packet_size (drizzle_con_st *con)

---

Detailed Description

These functions provide the core functionality for connection handling.

---

Enumeration Type Documentation

enum drizzle_con_options_t

Options for drizzle_con_st.

Enumerator:

DRIZZLE_CON_NONE
DRIZZLE_CON_ALLOCATED
DRIZZLE_CON_MYSQL
DRIZZLE_CON_RAW_PACKET
DRIZZLE_CON_RAW_SCRAMBLE
DRIZZLE_CON_READY
DRIZZLE_CON_NO_RESULT_READ
DRIZZLE_CON_IO_READY

enum drizzle_con_status_t

Status flags for drizle_con_st.

Enumerator:

DRIZZLE_CON_STATUS_NONE
DRIZZLE_CON_STATUS_IN_TRANS
DRIZZLE_CON_STATUS_AUTOCOMMIT
DRIZZLE_CON_STATUS_MORE_RESULTS_EXISTS
DRIZZLE_CON_STATUS_QUERY_NO_GOOD_INDEX_USED
DRIZZLE_CON_STATUS_QUERY_NO_INDEX_USED
DRIZZLE_CON_STATUS_CURSOR_EXISTS
DRIZZLE_CON_STATUS_LAST_ROW_SENT
DRIZZLE_CON_STATUS_DB_DROPPED
DRIZZLE_CON_STATUS_NO_BACKSLASH_ESCAPES
DRIZZLE_CON_STATUS_QUERY_WAS_SLOW

enum drizzle_capabilities_t

Capabilities for drizzle_con_st.

Enumerator:

DRIZZLE_CAPABILITIES_NONE
DRIZZLE_CAPABILITIES_LONG_PASSWORD
DRIZZLE_CAPABILITIES_FOUND_ROWS
DRIZZLE_CAPABILITIES_LONG_FLAG
DRIZZLE_CAPABILITIES_CONNECT_WITH_DB
DRIZZLE_CAPABILITIES_NO_SCHEMA
DRIZZLE_CAPABILITIES_COMPRESS
DRIZZLE_CAPABILITIES_ODBC
DRIZZLE_CAPABILITIES_LOCAL_FILES
DRIZZLE_CAPABILITIES_IGNORE_SPACE
DRIZZLE_CAPABILITIES_PROTOCOL_41
DRIZZLE_CAPABILITIES_INTERACTIVE
DRIZZLE_CAPABILITIES_SSL
DRIZZLE_CAPABILITIES_IGNORE_SIGPIPE
DRIZZLE_CAPABILITIES_TRANSACTIONS
DRIZZLE_CAPABILITIES_RESERVED
DRIZZLE_CAPABILITIES_SECURE_CONNECTION
DRIZZLE_CAPABILITIES_MULTI_STATEMENTS
DRIZZLE_CAPABILITIES_MULTI_RESULTS
DRIZZLE_CAPABILITIES_SSL_VERIFY_SERVER_CERT
DRIZZLE_CAPABILITIES_REMEMBER_OPTIONS
DRIZZLE_CAPABILITIES_CLIENT

---

Function Documentation

drizzle_con_st* drizzle_con_create	(	drizzle_st *	drizzle,
		drizzle_con_st *	con
	)

Initialize a connection structure.

drizzle_con_st* drizzle_con_clone	(	drizzle_st *	drizzle,
		drizzle_con_st *	con,
		drizzle_con_st *	from
	)

Clone a connection structure.

void drizzle_con_free

(

drizzle_con_st *

con

)

Free a connection structure.

int drizzle_con_fd

(

drizzle_con_st *

con

)

Get file descriptor for connection.

drizzle_return_t drizzle_con_set_fd	(	drizzle_con_st *	con,
		int	fd
	)

Use given file descriptor for connction.

void drizzle_con_close

(

drizzle_con_st *

con

)

Close a connection.

drizzle_return_t drizzle_con_wait

(

drizzle_st *

drizzle

)

Wait for I/O on connections.

drizzle_return_t drizzle_con_set_events	(	drizzle_con_st *	con,
		short	events
	)

Set events to be watched for a connection.

void drizzle_con_set_revents	(	drizzle_con_st *	con,
		short	revents
	)

Set events that are ready for a connection. This is used with the external event callbacks.

drizzle_con_st* drizzle_con_ready

(

drizzle_st *

drizzle

)

Get next connection that is ready for I/O.

drizzle_st* drizzle_con_drizzle

(

drizzle_con_st *

con

)

Get the drizzle_st struct that the connection belongs to.

const char* drizzle_con_error

(

drizzle_con_st *

con

)

Return an error string for last library error encountered.

int drizzle_con_errno

(

drizzle_con_st *

con

)

Value of errno in the case of a DRIZZLE_RETURN_ERRNO return value.

uint16_t drizzle_con_error_code

(

drizzle_con_st *

con

)

Get server defined error code for the last result read.

const char* drizzle_con_sqlstate

(

drizzle_con_st *

con

)

Get SQL state code for the last result read.

drizzle_con_options_t drizzle_con_options

(

drizzle_con_st *

con

)

Get options for a connection.

void drizzle_con_set_options	(	drizzle_con_st *	con,
		drizzle_con_options_t	options
	)

Set options for a connection.

void drizzle_con_add_options	(	drizzle_con_st *	con,
		drizzle_con_options_t	options
	)

Add options for a connection.

void drizzle_con_remove_options	(	drizzle_con_st *	con,
		drizzle_con_options_t	options
	)

Remove options for a connection.

const char* drizzle_con_host

(

drizzle_con_st *

con

)

Get TCP host for a connection.

in_port_t drizzle_con_port

(

drizzle_con_st *

con

)

Get TCP port for a connection.

void drizzle_con_set_tcp	(	drizzle_con_st *	con,
		const char *	host,
		in_port_t	port
	)

Set TCP host and port for a connection.

const char* drizzle_con_uds

(

drizzle_con_st *

con

)

Get unix domain socket for a connection.

void drizzle_con_set_uds	(	drizzle_con_st *	con,
		const char *	uds
	)

Set unix domain socket for a connection.

const char* drizzle_con_user

(

drizzle_con_st *

con

)

Get username for a connection.

const char* drizzle_con_password

(

drizzle_con_st *

con

)

Get password for a connection.

void drizzle_con_set_auth	(	drizzle_con_st *	con,
		const char *	user,
		const char *	password
	)

Set username and password for a connection.

const char* drizzle_con_db

(

drizzle_con_st *

con

)

Get database for a connection.

void drizzle_con_set_db	(	drizzle_con_st *	con,
		const char *	db
	)

Set database for a connection.

void* drizzle_con_data

(

drizzle_con_st *

con

)

Get application data pointer for a connection.

void drizzle_con_set_data	(	drizzle_con_st *	con,
		const void *	data
	)

Set application data pointer for a connection.

void drizzle_con_set_data_free	(	drizzle_con_st *	con,
		drizzle_con_data_free_fn *	free_fn
	)

Set callback function when the data pointer should be freed.

uint8_t drizzle_con_protocol_version

(

drizzle_con_st *

con

)

Get protocol version for a connection.

const char* drizzle_con_server_version

(

drizzle_con_st *

con

)

Get server version string for a connection.

uint32_t drizzle_con_server_version_number

(

drizzle_con_st *

con

)

Get server version number for a connection.

uint32_t drizzle_con_thread_id

(

drizzle_con_st *

con

)

Get thread ID for a connection.

const uint8_t* drizzle_con_scramble

(

drizzle_con_st *

con

)

Get scramble buffer for a connection.

drizzle_capabilities_t drizzle_con_capabilities

(

drizzle_con_st *

con

)

Get capabilities for a connection.

drizzle_charset_t drizzle_con_charset

(

drizzle_con_st *

con

)

Get charset for a connection.

drizzle_con_status_t drizzle_con_status

(

drizzle_con_st *

con

)

Get status for a connection.

uint32_t drizzle_con_max_packet_size

(

drizzle_con_st *

con

)

Get max packet size for a connection.