Gearman Public API Documentation

Task Declarations
[Client Declarations]

Data Structures

struct  gearman_task_st

Functions

GEARMAN_LOCAL gearman_task_stgearman_task_create (gearman_client_st *client, gearman_task_st *task)
void gearman_task_free (gearman_task_st *task)
const void * gearman_task_context (const gearman_task_st *task)
void gearman_task_set_context (gearman_task_st *task, void *context)
const char * gearman_task_function_name (const gearman_task_st *task)
const char * gearman_task_unique (const gearman_task_st *task)
const char * gearman_task_job_handle (const gearman_task_st *task)
bool gearman_task_is_known (const gearman_task_st *task)
bool gearman_task_is_running (const gearman_task_st *task)
uint32_t gearman_task_numerator (const gearman_task_st *task)
uint32_t gearman_task_denominator (const gearman_task_st *task)
void gearman_task_give_workload (gearman_task_st *task, const void *workload, size_t workload_size)
size_t gearman_task_send_workload (gearman_task_st *task, const void *workload, size_t workload_size, gearman_return_t *ret_ptr)
const void * gearman_task_data (const gearman_task_st *task)
size_t gearman_task_data_size (const gearman_task_st *task)
void * gearman_task_take_data (gearman_task_st *task, size_t *data_size)
size_t gearman_task_recv_data (gearman_task_st *task, void *data, size_t data_size, gearman_return_t *ret_ptr)

Detailed Description

The task functions are used to manage tasks being run by clients. They are most commonly used with the client interface.


Function Documentation

GEARMAN_LOCAL gearman_task_st* gearman_task_create ( gearman_client_st client,
gearman_task_st task 
)

Initialize a task structure.

Parameters:
[in] client Structure previously initialized with gearman_client_create() or gearman_client_clone().
[in] task Caller allocated structure, or NULL to allocate one.
Returns:
On success, a pointer to the (possibly allocated) structure. On failure this will be NULL.
void gearman_task_free ( gearman_task_st task  ) 

Free a task structure.

Parameters:
[in] task Structure previously initialized with one of the gearman_client_add_task() functions.
const void* gearman_task_context ( const gearman_task_st task  ) 

Get context for a task.

void gearman_task_set_context ( gearman_task_st task,
void *  context 
)

Set context for a task.

const char* gearman_task_function_name ( const gearman_task_st task  ) 

Get function name associated with a task.

const char* gearman_task_unique ( const gearman_task_st task  ) 

Get unique identifier for a task.

const char* gearman_task_job_handle ( const gearman_task_st task  ) 

Get job handle for a task.

bool gearman_task_is_known ( const gearman_task_st task  ) 

Get status on whether a task is known or not.

bool gearman_task_is_running ( const gearman_task_st task  ) 

Get status on whether a task is running or not.

uint32_t gearman_task_numerator ( const gearman_task_st task  ) 

Get the numerator of percentage complete for a task.

uint32_t gearman_task_denominator ( const gearman_task_st task  ) 

Get the denominator of percentage complete for a task.

void gearman_task_give_workload ( gearman_task_st task,
const void *  workload,
size_t  workload_size 
)

Give allocated memory to task. After this, the library will be responsible for freeing the workload memory when the task is destroyed.

size_t gearman_task_send_workload ( gearman_task_st task,
const void *  workload,
size_t  workload_size,
gearman_return_t ret_ptr 
)

Send packet workload for a task.

const void* gearman_task_data ( const gearman_task_st task  ) 

Get result data being returned for a task.

size_t gearman_task_data_size ( const gearman_task_st task  ) 

Get result data size being returned for a task.

void* gearman_task_take_data ( gearman_task_st task,
size_t *  data_size 
)

Take allocated result data from task. After this, the caller is responsible for free()ing the memory.

size_t gearman_task_recv_data ( gearman_task_st task,
void *  data,
size_t  data_size,
gearman_return_t ret_ptr 
)

Read result data into a buffer for a task.

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