Gearman Public API Documentation

Thread Declarations
[Gearmand Declarations]

Data Structures

struct  gearmand_thread_st

Enumerations

enum  gearmand_thread_options_t { GEARMAND_THREAD_WAKEUP_EVENT = (1 << 0), GEARMAND_THREAD_LOCK = (1 << 1) }

Functions

gearman_return_t gearmand_thread_create (gearmand_st *gearmand)
void gearmand_thread_free (gearmand_thread_st *thread)
void gearmand_thread_wakeup (gearmand_thread_st *thread, gearmand_wakeup_t wakeup)
void gearmand_thread_run (gearmand_thread_st *thread)

Detailed Description

Thread handling for gearmand.


Enumeration Type Documentation

Options for gearmand_thread_st.

Enumerator:
GEARMAND_THREAD_WAKEUP_EVENT 
GEARMAND_THREAD_LOCK 

Definition at line 93 of file constants.h.


Function Documentation

gearman_return_t gearmand_thread_create ( gearmand_st gearmand  ) 

Create a new gearmand thread.

Parameters:
gearmand Server instance structure previously initialized with gearmand_create.
Returns:
Standard gearman return value.
void gearmand_thread_free ( gearmand_thread_st thread  ) 

Free resources used by a thread.

Parameters:
thread Thread previously initialized with gearmand_thread_create.
void gearmand_thread_wakeup ( gearmand_thread_st thread,
gearmand_wakeup_t  wakeup 
)

Interrupt a running gearmand thread.

Parameters:
thread Thread structure previously initialized with gearmand_thread_create.
wakeup Wakeup event to send to running thread.
void gearmand_thread_run ( gearmand_thread_st thread  ) 

Run the thread when there are events ready.

Parameters:
thread Thread structure previously initialized with gearmand_thread_create.
Generated on Tue Jun 15 11:40:19 2010 by  doxygen 1.6.3