libdrizzle Developer Documentation

Connection Handling
[Drizzle Client InterfaceDrizzle Server Interface]

Data Structures

struct  drizzle_con_st

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_stdrizzle_con_create (drizzle_st *drizzle, drizzle_con_st *con)
drizzle_con_stdrizzle_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_stdrizzle_con_ready (drizzle_st *drizzle)
drizzle_stdrizzle_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

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 

Definition at line 127 of file constants.h.

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 143 of file constants.h.

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 162 of file constants.h.


Function Documentation

drizzle_con_st* drizzle_con_create ( drizzle_st drizzle,
drizzle_con_st con 
)

Initialize a connection structure.

Definition at line 39 of file conn.c.

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

Clone a connection structure.

Definition at line 119 of file conn.c.

void drizzle_con_free ( drizzle_con_st con  ) 

Free a connection structure.

Definition at line 146 of file conn.c.

int drizzle_con_fd ( drizzle_con_st con  ) 

Get file descriptor for connection.

Definition at line 179 of file conn.c.

drizzle_return_t drizzle_con_set_fd ( drizzle_con_st con,
int  fd 
)

Use given file descriptor for connction.

Definition at line 184 of file conn.c.

void drizzle_con_close ( drizzle_con_st con  ) 

Close a connection.

Definition at line 197 of file conn.c.

drizzle_return_t drizzle_con_wait ( drizzle_st drizzle  ) 

Wait for I/O on connections.

Definition at line 215 of file conn.c.

drizzle_return_t drizzle_con_set_events ( drizzle_con_st con,
short  events 
)

Set events to be watched for a connection.

Definition at line 286 of file conn.c.

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.

Definition at line 309 of file conn.c.

drizzle_con_st* drizzle_con_ready ( drizzle_st drizzle  ) 

Get next connection that is ready for I/O.

Definition at line 318 of file conn.c.

drizzle_st* drizzle_con_drizzle ( drizzle_con_st con  ) 

Get the drizzle_st struct that the connection belongs to.

Definition at line 337 of file conn.c.

const char* drizzle_con_error ( drizzle_con_st con  ) 

Return an error string for last library error encountered.

Definition at line 342 of file conn.c.

int drizzle_con_errno ( drizzle_con_st con  ) 

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

Definition at line 347 of file conn.c.

uint16_t drizzle_con_error_code ( drizzle_con_st con  ) 

Get server defined error code for the last result read.

Definition at line 352 of file conn.c.

const char* drizzle_con_sqlstate ( drizzle_con_st con  ) 

Get SQL state code for the last result read.

Definition at line 357 of file conn.c.

drizzle_con_options_t drizzle_con_options ( drizzle_con_st con  ) 

Get options for a connection.

Definition at line 362 of file conn.c.

void drizzle_con_set_options ( drizzle_con_st con,
drizzle_con_options_t  options 
)

Set options for a connection.

Definition at line 367 of file conn.c.

void drizzle_con_add_options ( drizzle_con_st con,
drizzle_con_options_t  options 
)

Add options for a connection.

Definition at line 373 of file conn.c.

void drizzle_con_remove_options ( drizzle_con_st con,
drizzle_con_options_t  options 
)

Remove options for a connection.

Definition at line 379 of file conn.c.

const char* drizzle_con_host ( drizzle_con_st con  ) 

Get TCP host for a connection.

Definition at line 385 of file conn.c.

in_port_t drizzle_con_port ( drizzle_con_st con  ) 

Get TCP port for a connection.

Definition at line 390 of file conn.c.

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

Set TCP host and port for a connection.

Definition at line 401 of file conn.c.

const char* drizzle_con_uds ( drizzle_con_st con  ) 

Get unix domain socket for a connection.

Definition at line 22 of file conn_uds.c.

void drizzle_con_set_uds ( drizzle_con_st con,
const char *  uds 
)

Set unix domain socket for a connection.

Definition at line 27 of file conn_uds.c.

const char* drizzle_con_user ( drizzle_con_st con  ) 

Get username for a connection.

Definition at line 415 of file conn.c.

const char* drizzle_con_password ( drizzle_con_st con  ) 

Get password for a connection.

Definition at line 420 of file conn.c.

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

Set username and password for a connection.

Definition at line 425 of file conn.c.

const char* drizzle_con_db ( drizzle_con_st con  ) 

Get database for a connection.

Definition at line 443 of file conn.c.

void drizzle_con_set_db ( drizzle_con_st con,
const char *  db 
)

Set database for a connection.

Definition at line 448 of file conn.c.

void* drizzle_con_data ( drizzle_con_st con  ) 

Get application data pointer for a connection.

Definition at line 472 of file conn.c.

void drizzle_con_set_data ( drizzle_con_st con,
const void *  data 
)

Set application data pointer for a connection.

Definition at line 477 of file conn.c.

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.

Definition at line 482 of file conn.c.

uint8_t drizzle_con_protocol_version ( drizzle_con_st con  ) 

Get protocol version for a connection.

Definition at line 488 of file conn.c.

const char* drizzle_con_server_version ( drizzle_con_st con  ) 

Get server version string for a connection.

Definition at line 493 of file conn.c.

uint32_t drizzle_con_server_version_number ( drizzle_con_st con  ) 

Get server version number for a connection.

Definition at line 498 of file conn.c.

uint32_t drizzle_con_thread_id ( drizzle_con_st con  ) 

Get thread ID for a connection.

Definition at line 517 of file conn.c.

const uint8_t* drizzle_con_scramble ( drizzle_con_st con  ) 

Get scramble buffer for a connection.

Definition at line 522 of file conn.c.

drizzle_capabilities_t drizzle_con_capabilities ( drizzle_con_st con  ) 

Get capabilities for a connection.

Definition at line 527 of file conn.c.

drizzle_charset_t drizzle_con_charset ( drizzle_con_st con  ) 

Get charset for a connection.

Definition at line 532 of file conn.c.

drizzle_con_status_t drizzle_con_status ( drizzle_con_st con  ) 

Get status for a connection.

Definition at line 537 of file conn.c.

uint32_t drizzle_con_max_packet_size ( drizzle_con_st con  ) 

Get max packet size for a connection.

Definition at line 542 of file conn.c.


Generated on Mon Sep 28 12:54:05 2009 by  doxygen 1.6.1