libdrizzle Developer Documentation

Connection Declarations for Servers
[Drizzle Server Interface]

Functions

drizzle_return_t drizzle_con_listen (drizzle_con_st *con)
int drizzle_con_backlog (const drizzle_con_st *con)
void drizzle_con_set_backlog (drizzle_con_st *con, int backlog)
void drizzle_con_set_protocol_version (drizzle_con_st *con, uint8_t protocol_version)
void drizzle_con_set_server_version (drizzle_con_st *con, const char *server_version)
void drizzle_con_set_thread_id (drizzle_con_st *con, uint32_t thread_id)
void drizzle_con_set_scramble (drizzle_con_st *con, const uint8_t *scramble)
void drizzle_con_set_capabilities (drizzle_con_st *con, drizzle_capabilities_t capabilities)
void drizzle_con_set_charset (drizzle_con_st *con, drizzle_charset_t charset)
void drizzle_con_set_status (drizzle_con_st *con, drizzle_con_status_t status)
void drizzle_con_set_max_packet_size (drizzle_con_st *con, uint32_t max_packet_size)
void drizzle_con_copy_handshake (drizzle_con_st *con, drizzle_con_st *from)
void * drizzle_con_command_read (drizzle_con_st *con, drizzle_command_t *command, size_t *offset, size_t *size, size_t *total, drizzle_return_t *ret_ptr)
void * drizzle_con_command_buffer (drizzle_con_st *con, drizzle_command_t *command, size_t *total, drizzle_return_t *ret_ptr)

Detailed Description

These functions extend the core connection functions with a set of functions for server application use. These functions allow you to set raw handshake information for use with the handshake write functions.


Function Documentation

drizzle_return_t drizzle_con_listen ( drizzle_con_st con  ) 

Put a connection into listening mode.

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 510 of file conn.c.

int drizzle_con_backlog ( const drizzle_con_st con  ) 

Get connection backlog queue length.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
Returns:
Backlog for connection

Definition at line 524 of file conn.c.

void drizzle_con_set_backlog ( drizzle_con_st con,
int  backlog 
)

Set connection backlog queue length.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] backlog Backlog to use for connection

Definition at line 529 of file conn.c.

void drizzle_con_set_protocol_version ( drizzle_con_st con,
uint8_t  protocol_version 
)

Set protocol version for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] protocol_version Protocol version to use for connection

Definition at line 534 of file conn.c.

void drizzle_con_set_server_version ( drizzle_con_st con,
const char *  server_version 
)

Set server version string for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] server_version Server version to use for connection

Definition at line 540 of file conn.c.

void drizzle_con_set_thread_id ( drizzle_con_st con,
uint32_t  thread_id 
)

Set thread ID for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] thread_id Thread ID to use for connection

Definition at line 553 of file conn.c.

void drizzle_con_set_scramble ( drizzle_con_st con,
const uint8_t *  scramble 
)

Set scramble buffer for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] scramble Scramble to use for connection

Definition at line 558 of file conn.c.

void drizzle_con_set_capabilities ( drizzle_con_st con,
drizzle_capabilities_t  capabilities 
)

Set capabilities for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] capabilities Capabilities to use for connection

Definition at line 569 of file conn.c.

void drizzle_con_set_charset ( drizzle_con_st con,
drizzle_charset_t  charset 
)

Set charset for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] charset Character set to use for connection

Definition at line 575 of file conn.c.

void drizzle_con_set_status ( drizzle_con_st con,
drizzle_con_status_t  status 
)

Set status for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] status Status to use for connection

Definition at line 580 of file conn.c.

void drizzle_con_set_max_packet_size ( drizzle_con_st con,
uint32_t  max_packet_size 
)

Set max packet size for a connection.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] max_packet_size Max packet size to use for connection

Definition at line 585 of file conn.c.

void drizzle_con_copy_handshake ( drizzle_con_st con,
drizzle_con_st from 
)

Copy all handshake information from one connection into another.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[in] from Connection structure to copy from.

Definition at line 591 of file conn.c.

void* drizzle_con_command_read ( drizzle_con_st con,
drizzle_command_t command,
size_t *  offset,
size_t *  size,
size_t *  total,
drizzle_return_t ret_ptr 
)

Read command without buffering.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[out] command Command that was read.
[out] offset Where the data being returned begins in the command data.
[out] size The size of the data chunk being returned.
[out] total The total size of all command data being read.
[out] ret_ptr Standard drizzle return value.
Returns:
On success, a pointer to an internal buffer with the command data. It will be *size bytes in length.

Definition at line 606 of file conn.c.

void* drizzle_con_command_buffer ( drizzle_con_st con,
drizzle_command_t command,
size_t *  total,
drizzle_return_t ret_ptr 
)

Read command and buffer it.

Parameters:
[in] con Connection structure previously initialized with drizzle_con_create(), drizzle_con_clone(), or related functions.
[out] command Command that was read.
[out] total The total size of all command data being read.
[out] ret_ptr Standard drizzle return value.
Returns:
On success, allocated buffer that holds the command data of length *total.

Definition at line 634 of file conn.c.

Generated by  doxygen 1.6.2-20100208