libdrizzle Developer Documentation

Topics | Data Structures | Enumerations | Functions
Connection Declarations
Drizzle Client Interface | Drizzle Server Interface

Topics

 Static Connection Declarations
 
 Local Connection Declarations
 

Data Structures

struct  drizzle_con_tcp_st
 
struct  drizzle_con_uds_st
 
struct  drizzle_con_st
 

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) ,
  DRIZZLE_CON_LISTEN = (1 << 7) , DRIZZLE_CON_EXPERIMENTAL = (1 << 8)
}
 
enum  drizzle_con_socket_t { DRIZZLE_CON_SOCKET_TCP = 0 , DRIZZLE_CON_SOCKET_UDS = (1 << 0) }
 
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

int drizzle_con_fd (const 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_set_events (drizzle_con_st *con, short events)
 
drizzle_return_t drizzle_con_set_revents (drizzle_con_st *con, short revents)
 
drizzle_st * drizzle_con_drizzle (const drizzle_con_st *con)
 
const char * drizzle_con_error (const drizzle_con_st *con)
 
int drizzle_con_errno (const drizzle_con_st *con)
 
uint16_t drizzle_con_error_code (const drizzle_con_st *con)
 
const char * drizzle_con_sqlstate (const drizzle_con_st *con)
 
drizzle_con_options_t drizzle_con_options (const 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 (const drizzle_con_st *con)
 
in_port_t drizzle_con_port (const 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 (const drizzle_con_st *con)
 
void drizzle_con_set_uds (drizzle_con_st *con, const char *uds)
 
const char * drizzle_con_user (const drizzle_con_st *con)
 
const char * drizzle_con_password (const drizzle_con_st *con)
 
void drizzle_con_set_auth (drizzle_con_st *con, const char *user, const char *password)
 
const char * drizzle_con_db (const drizzle_con_st *con)
 
void drizzle_con_set_db (drizzle_con_st *con, const char *db)
 
void * drizzle_con_context (const drizzle_con_st *con)
 
void drizzle_con_set_context (drizzle_con_st *con, void *context)
 
void drizzle_con_set_context_free_fn (drizzle_con_st *con, drizzle_con_context_free_fn *function)
 
uint8_t drizzle_con_protocol_version (const drizzle_con_st *con)
 
const char * drizzle_con_server_version (const drizzle_con_st *con)
 
uint32_t drizzle_con_server_version_number (const drizzle_con_st *con)
 
uint32_t drizzle_con_thread_id (const drizzle_con_st *con)
 
const uint8_t * drizzle_con_scramble (const drizzle_con_st *con)
 
drizzle_capabilities_t drizzle_con_capabilities (const drizzle_con_st *con)
 
drizzle_charset_t drizzle_con_charset (const drizzle_con_st *con)
 
drizzle_con_status_t drizzle_con_status (const drizzle_con_st *con)
 
uint32_t drizzle_con_max_packet_size (const drizzle_con_st *con)
 

Detailed Description

Enumeration Type Documentation

◆ drizzle_con_options_t

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 
DRIZZLE_CON_LISTEN 
DRIZZLE_CON_EXPERIMENTAL 

Definition at line 131 of file constants.h.

◆ drizzle_con_socket_t

enum drizzle_con_socket_t

Socket types for drizzle_con_st.

Enumerator
DRIZZLE_CON_SOCKET_TCP 
DRIZZLE_CON_SOCKET_UDS 

Definition at line 149 of file constants.h.

◆ drizzle_con_status_t

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 

Definition at line 159 of file constants.h.

◆ drizzle_capabilities_t

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 

Definition at line 178 of file constants.h.

Function Documentation

◆ drizzle_con_fd()

int drizzle_con_fd ( const drizzle_con_st * con)

Get file descriptor for connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
File descriptor of connection, or -1 if not active.

Definition at line 39 of file conn.c.

◆ drizzle_con_set_fd()

drizzle_return_t drizzle_con_set_fd ( drizzle_con_st * con,
int fd )

Use given file descriptor for connction.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]fdFile descriptor for connection.
Returns
Standard drizzle return value.

Definition at line 44 of file conn.c.

◆ drizzle_con_close()

void drizzle_con_close ( drizzle_con_st * con)

Close a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.

Definition at line 57 of file conn.c.

◆ drizzle_con_set_events()

drizzle_return_t drizzle_con_set_events ( drizzle_con_st * con,
short events )

Set events to be watched for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]eventsBitfield of poll() events to watch.
Returns
Standard drizzle return value.

Definition at line 75 of file conn.c.

◆ drizzle_con_set_revents()

drizzle_return_t 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. See drizzle_set_event_watch_fn().

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]reventsBitfield of poll() events that were detected.
Returns
Standard drizzle return value.

Definition at line 98 of file conn.c.

◆ drizzle_con_drizzle()

drizzle_st * drizzle_con_drizzle ( const drizzle_con_st * con)

Get the drizzle_st struct that the connection belongs to.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Drizzle object that this connection is part of.

Definition at line 128 of file conn.c.

◆ drizzle_con_error()

const char * drizzle_con_error ( const drizzle_con_st * con)

Return an error string for last error encountered.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Pointer to static buffer in library that holds an error string.

Definition at line 133 of file conn.c.

◆ drizzle_con_errno()

int drizzle_con_errno ( const drizzle_con_st * con)

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

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
An errno value as defined in your system errno.h file.

Definition at line 138 of file conn.c.

◆ drizzle_con_error_code()

uint16_t drizzle_con_error_code ( const drizzle_con_st * con)

Get server defined error code for the last result read.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
An error code given back in the server response.

Definition at line 143 of file conn.c.

◆ drizzle_con_sqlstate()

const char * drizzle_con_sqlstate ( const drizzle_con_st * con)

Get SQL state code for the last result read.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
A SQLSTATE code given back in the server response.

Definition at line 148 of file conn.c.

◆ drizzle_con_options()

drizzle_con_options_t drizzle_con_options ( const drizzle_con_st * con)

Get options for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Options set for the connection structure.

Definition at line 153 of file conn.c.

◆ drizzle_con_set_options()

void drizzle_con_set_options ( drizzle_con_st * con,
drizzle_con_options_t options )

Set options for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to set.

Definition at line 158 of file conn.c.

◆ drizzle_con_add_options()

void drizzle_con_add_options ( drizzle_con_st * con,
drizzle_con_options_t options )

Add options for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to set.

Definition at line 164 of file conn.c.

◆ drizzle_con_remove_options()

void drizzle_con_remove_options ( drizzle_con_st * con,
drizzle_con_options_t options )

Remove options for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]optionsAvailable options for connection structure to remove.

Definition at line 174 of file conn.c.

◆ drizzle_con_host()

const char * drizzle_con_host ( const drizzle_con_st * con)

Get TCP host for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Host this connection is configured for, or NULL if not set.

Definition at line 180 of file conn.c.

◆ drizzle_con_port()

in_port_t drizzle_con_port ( const drizzle_con_st * con)

Get TCP port for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Port this connection is configured for, 0 if not set.

Definition at line 193 of file conn.c.

◆ drizzle_con_set_tcp()

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

Set TCP host and port for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]hostHost to use for this connection, NULL for default value.
[in]portPort to use for this connection, 0 for default value.

Definition at line 209 of file conn.c.

◆ drizzle_con_uds()

const char * drizzle_con_uds ( const drizzle_con_st * con)

Get unix domain socket for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Unix domain socket set for this connection, NULL if not set.

Definition at line 18 of file conn_uds.c.

◆ drizzle_con_set_uds()

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

Set unix domain socket for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]udsUnix domain socket to use for this connection, NULL for defailt value.

Definition at line 34 of file conn_uds.c.

◆ drizzle_con_user()

const char * drizzle_con_user ( const drizzle_con_st * con)

Get username for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
User associated with this connection.

Definition at line 227 of file conn.c.

◆ drizzle_con_password()

const char * drizzle_con_password ( const drizzle_con_st * con)

Get password for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Password associated with this connection.

Definition at line 232 of file conn.c.

◆ drizzle_con_set_auth()

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

Set username and password for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]userUsername to use for this connection.
[in]passwordPassword to use for this connection.

Definition at line 237 of file conn.c.

◆ drizzle_con_db()

const char * drizzle_con_db ( const drizzle_con_st * con)

Get database for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Database associated with this connection.

Definition at line 257 of file conn.c.

◆ drizzle_con_set_db()

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

Set database for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]dbDatabase to use with this connection.

Definition at line 262 of file conn.c.

◆ drizzle_con_context()

void * drizzle_con_context ( const drizzle_con_st * con)

Get application context pointer for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Application context with this connection.

Definition at line 273 of file conn.c.

◆ drizzle_con_set_context()

void drizzle_con_set_context ( drizzle_con_st * con,
void * context )

Set application context pointer for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]contextApplication context to use with this connection.

Definition at line 278 of file conn.c.

◆ drizzle_con_set_context_free_fn()

void drizzle_con_set_context_free_fn ( drizzle_con_st * con,
drizzle_con_context_free_fn * function )

Set callback function when the context pointer should be freed.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in]functionFunction to call to clean up connection context.

Definition at line 283 of file conn.c.

◆ drizzle_con_protocol_version()

uint8_t drizzle_con_protocol_version ( const drizzle_con_st * con)

Get protocol version for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Protocol version for connection.

Definition at line 289 of file conn.c.

◆ drizzle_con_server_version()

const char * drizzle_con_server_version ( const drizzle_con_st * con)

Get server version string for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Server version string for connection.

Definition at line 294 of file conn.c.

◆ drizzle_con_server_version_number()

uint32_t drizzle_con_server_version_number ( const drizzle_con_st * con)

Get server version number for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Server version number for connection.

Definition at line 299 of file conn.c.

◆ drizzle_con_thread_id()

uint32_t drizzle_con_thread_id ( const drizzle_con_st * con)

Get thread ID for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Thread ID for connection.

Definition at line 318 of file conn.c.

◆ drizzle_con_scramble()

const uint8_t * drizzle_con_scramble ( const drizzle_con_st * con)

Get scramble buffer for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Scramble buffer for connection.

Definition at line 323 of file conn.c.

◆ drizzle_con_capabilities()

drizzle_capabilities_t drizzle_con_capabilities ( const drizzle_con_st * con)

Get capabilities for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Capabilities for connection.

Definition at line 328 of file conn.c.

◆ drizzle_con_charset()

drizzle_charset_t drizzle_con_charset ( const drizzle_con_st * con)

Get character set for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Character set for connection.

Definition at line 333 of file conn.c.

◆ drizzle_con_status()

drizzle_con_status_t drizzle_con_status ( const drizzle_con_st * con)

Get status for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Status for connection.

Definition at line 338 of file conn.c.

◆ drizzle_con_max_packet_size()

uint32_t drizzle_con_max_packet_size ( const drizzle_con_st * con)

Get max packet size for a connection.

Parameters
[in]conConnection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns
Max packet size for connection.

Definition at line 343 of file conn.c.

Generated by doxygen 1.12.0