Gearman Developer Documentation

Connection Declarations
[Gearman Server Declarations]

Data Structures

struct  gearman_server_con_st

Enumerations

enum  gearman_server_con_options_t { GEARMAN_SERVER_CON_SLEEPING = (1 << 0), GEARMAN_SERVER_CON_EXCEPTIONS = (1 << 1), GEARMAN_SERVER_CON_DEAD = (1 << 2), GEARMAN_SERVER_CON_NOOP_SENT = (1 << 3) }

Functions

gearman_server_con_stgearman_server_con_add (gearman_server_thread_st *thread, int fd, void *data)
gearman_server_con_stgearman_server_con_create (gearman_server_thread_st *thread)
void gearman_server_con_free (gearman_server_con_st *con)
gearman_connection_stgearman_server_con_con (gearman_server_con_st *con)
const void * gearman_server_con_data (const gearman_server_con_st *con)
void gearman_server_con_set_data (gearman_server_con_st *con, void *data)
const char * gearman_server_con_host (gearman_server_con_st *con)
void gearman_server_con_set_host (gearman_server_con_st *con, const char *host)
const char * gearman_server_con_port (gearman_server_con_st *con)
void gearman_server_con_set_port (gearman_server_con_st *con, const char *port)
const char * gearman_server_con_id (gearman_server_con_st *con)
void gearman_server_con_set_id (gearman_server_con_st *con, char *id, size_t size)
void gearman_server_con_free_worker (gearman_server_con_st *con, char *function_name, size_t function_name_size)
void gearman_server_con_free_workers (gearman_server_con_st *con)
void gearman_server_con_io_add (gearman_server_con_st *con)
void gearman_server_con_io_remove (gearman_server_con_st *con)
gearman_server_con_stgearman_server_con_io_next (gearman_server_thread_st *thread)
void gearman_server_con_proc_add (gearman_server_con_st *con)
void gearman_server_con_proc_remove (gearman_server_con_st *con)
gearman_server_con_stgearman_server_con_proc_next (gearman_server_thread_st *thread)

Detailed Description

This is a low level interface for gearman server connections. This is used internally by the server interface, so you probably want to look there first.


Enumeration Type Documentation

Options for gearman_server_con_st.

Enumerator:
GEARMAN_SERVER_CON_SLEEPING 
GEARMAN_SERVER_CON_EXCEPTIONS 
GEARMAN_SERVER_CON_DEAD 
GEARMAN_SERVER_CON_NOOP_SENT 

Definition at line 48 of file constants.h.


Function Documentation

gearman_server_con_st* gearman_server_con_add ( gearman_server_thread_st thread,
int  fd,
void *  data 
)

Add a connection to a server thread. This goes into a list of connections that is used later with server_thread_run, no socket I/O happens here.

Parameters:
thread Thread structure previously initialized with gearman_server_thread_create.
fd File descriptor for a newly accepted connection.
data Application data pointer.
Returns:
Gearman server connection pointer.

Definition at line 20 of file connection.c.

gearman_server_con_st* gearman_server_con_create ( gearman_server_thread_st thread  ) 

Initialize a server connection structure.

Definition at line 49 of file connection.c.

void gearman_server_con_free ( gearman_server_con_st con  ) 

Free a server connection structure.

Definition at line 107 of file connection.c.

gearman_connection_st* gearman_server_con_con ( gearman_server_con_st con  ) 

Get gearman connection pointer the server connection uses.

Definition at line 163 of file connection.c.

const void* gearman_server_con_data ( const gearman_server_con_st con  ) 

Get application data pointer.

Definition at line 168 of file connection.c.

void gearman_server_con_set_data ( gearman_server_con_st con,
void *  data 
)

Set application data pointer.

Definition at line 173 of file connection.c.

const char* gearman_server_con_host ( gearman_server_con_st con  ) 

Get client host.

Definition at line 178 of file connection.c.

void gearman_server_con_set_host ( gearman_server_con_st con,
const char *  host 
)

Set client host.

Definition at line 183 of file connection.c.

const char* gearman_server_con_port ( gearman_server_con_st con  ) 

Get client port.

Definition at line 188 of file connection.c.

void gearman_server_con_set_port ( gearman_server_con_st con,
const char *  port 
)

Set client port.

Definition at line 193 of file connection.c.

const char* gearman_server_con_id ( gearman_server_con_st con  ) 

Get client id.

Definition at line 198 of file connection.c.

void gearman_server_con_set_id ( gearman_server_con_st con,
char *  id,
size_t  size 
)

Set client id.

Definition at line 203 of file connection.c.

void gearman_server_con_free_worker ( gearman_server_con_st con,
char *  function_name,
size_t  function_name_size 
)

Free server worker struction with name for a server connection.

Definition at line 213 of file connection.c.

void gearman_server_con_free_workers ( gearman_server_con_st con  ) 

Free all server worker structures for a server connection.

Definition at line 243 of file connection.c.

void gearman_server_con_io_add ( gearman_server_con_st con  ) 

Add connection to the io thread list.

Definition at line 249 of file connection.c.

void gearman_server_con_io_remove ( gearman_server_con_st con  ) 

Remove connection from the io thread list.

Definition at line 271 of file connection.c.

gearman_server_con_st* gearman_server_con_io_next ( gearman_server_thread_st thread  ) 

Get next connection from the io thread list.

Definition at line 283 of file connection.c.

void gearman_server_con_proc_add ( gearman_server_con_st con  ) 

Add connection to the proc thread list.

Definition at line 295 of file connection.c.

void gearman_server_con_proc_remove ( gearman_server_con_st con  ) 

Remove connection from the proc thread list.

Definition at line 315 of file connection.c.

gearman_server_con_st* gearman_server_con_proc_next ( gearman_server_thread_st thread  ) 

Get next connection from the proc thread list.

Definition at line 328 of file connection.c.

Generated on Tue Jun 15 11:40:21 2010 by  doxygen 1.6.3