Gearman Public API Documentation

Job Declarations
[Gearman Server Declarations]

Data Structures

struct  gearman_server_job_st

Enumerations

enum  gearman_server_job_state_t { GEARMAN_SERVER_JOB_QUEUED = (1 << 1), GEARMAN_SERVER_JOB_IGNORE = (1 << 2) }

Functions

gearman_server_job_stgearman_server_job_add (gearman_server_st *server, const char *function_name, size_t function_name_size, const char *unique, size_t unique_size, const void *data, size_t data_size, gearman_job_priority_t priority, gearman_server_client_st *server_client, gearman_return_t *ret_ptr)
gearman_server_job_stgearman_server_job_create (gearman_server_st *server, gearman_server_job_st *server_job)
void gearman_server_job_free (gearman_server_job_st *server_job)
gearman_server_job_stgearman_server_job_get (gearman_server_st *server, const char *job_handle, gearman_server_con_st *worker_con)
gearman_server_job_stgearman_server_job_peek (gearman_server_con_st *server_con)
gearman_server_job_stgearman_server_job_take (gearman_server_con_st *server_con)
gearman_return_t gearman_server_job_queue (gearman_server_job_st *server_job)

Detailed Description

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


Enumeration Type Documentation

Options for gearman_server_job_st.

Enumerator:
GEARMAN_SERVER_JOB_QUEUED 
GEARMAN_SERVER_JOB_IGNORE 

Definition at line 60 of file constants.h.


Function Documentation

gearman_server_job_st* gearman_server_job_add ( gearman_server_st server,
const char *  function_name,
size_t  function_name_size,
const char *  unique,
size_t  unique_size,
const void *  data,
size_t  data_size,
gearman_job_priority_t  priority,
gearman_server_client_st server_client,
gearman_return_t ret_ptr 
)

Add a new job to a server instance.

gearman_server_job_st* gearman_server_job_create ( gearman_server_st server,
gearman_server_job_st server_job 
)

Initialize a server job structure.

void gearman_server_job_free ( gearman_server_job_st server_job  ) 

Free a server job structure.

gearman_server_job_st* gearman_server_job_get ( gearman_server_st server,
const char *  job_handle,
gearman_server_con_st worker_con 
)

Get a server job structure from the job handle.

gearman_server_job_st* gearman_server_job_peek ( gearman_server_con_st server_con  ) 

See if there are any jobs to be run for the server worker connection.

gearman_server_job_st* gearman_server_job_take ( gearman_server_con_st server_con  ) 

Start running a job for the server worker connection.

gearman_return_t gearman_server_job_queue ( gearman_server_job_st server_job  ) 

Queue a job to be run.

Generated on Mon Jun 14 15:58:44 2010 by  doxygen 1.6.3