gearman_worker_define_function(3) [debian man page]

GEARMAN_WORKER_DEFINE_FUNCTION(3)				     Gearmand					 GEARMAN_WORKER_DEFINE_FUNCTION(3)

NAME

       gearman_worker_define_function - Gearmand Documentation, http://gearman.info/

SYNOPSIS

       #include <libgearman/gearman.h>

       gearman_function_t

       gearman_return_t  gearman_worker_define_function(gearman_worker_st *worker,  const  char *function_name, const size_t function_name_length,
       const gearman_function_t function, const uint32_t timeout, void *context)

       gearman_function_fn

       gearman_aggregator_fn

       Link with -lgearman

DESCRIPTION

       gearman_worker_define_function() defines functions for a worker.

       The interface is callback by design. When the server has a job for the worker, gearman_function_fn is evoked with a  gearman_job_st  repre-
       senting the job, and the context that was defined originally when the function was defined.

       Results are sent back to the client by invoking gearman_job_send_data().

       If  the	client	specified an reducer function, then the output of the gearman_function_fn will be sent to that function. You can split the
       work out to the reducer function by sending data multiple times with gearman_job_send_data().

       If any errors are detected then the entire job is cancelled.  The gearman_aggregator_fn will be called when all mapped jobs have completed.
       The result of this function will be what is returned to the client.

       The callback function needs to return one of the following errors:

       GEARMAN_SUCCESS

       The function was successful.

       GEARMAN_FAIL

       An error has occurred, the job we not processed, and the worker cannot continue.

       GEARMAN_ERROR

       A transient error has occurred, like a network failure, and the job can be restarted.

       If a value other then the above are returned it is converted to a GEARMAN_FAIL and gearman_worker_work() returns GEARMAN_INVALID_ARGUMENT.

       gearman_job_send_complete() and gearman_job_send_fail() cannot be used with any functions created with gearman_worker_define_function().

RETURN VALUE

       gearman_return_t

HOME

       To find out more information please check: http://gearman.info/

SEE ALSO

       gearmand(8) libgearman(3) gearman_strerror(3) gearman_client_error gearman_client_execute_reduce

AUTHOR

       Data Differential http://www.datadifferential.com/

COPYRIGHT

       2012, Data Differential, http://www.datadifferential.com/

0.33								   May 04, 2012 				 GEARMAN_WORKER_DEFINE_FUNCTION(3)

GEARMAN_JOB_FREE(3)						     Gearmand						       GEARMAN_JOB_FREE(3)

NAME

       gearman_job_free - Gearmand Documentation, http://gearman.info/

SYNOPSIS

       #include <libgearman/gearman.h>

       gearman_job_st

       void gearman_job_free(gearman_job_st *job)

       gearman_return_t gearman_job_send_data(gearman_job_st *job, const void *data, size_t data_size)

       gearman_return_t gearman_job_send_warning(gearman_job_st *job, const void *warning, size_t warning_size)

       gearman_return_t gearman_job_send_status(gearman_job_st *job, uint32_t numerator, uint32_t denominator)

       gearman_return_t gearman_job_send_complete(gearman_job_st *job, const void *result, size_t result_size)

       gearman_return_t gearman_job_send_exception(gearman_job_st *job, const void *exception, size_t exception_size)

       gearman_return_t gearman_job_send_fail(gearman_job_st *job)

       const char *gearman_job_handle(const gearman_job_st *job)

       const char *gearman_job_function_name(const gearman_job_st *job)

       const char *gearman_job_unique(const gearman_job_st *job)

       const void *gearman_job_workload(const gearman_job_st *job)

       size_t gearman_job_workload_size(const gearman_job_st *job)

       void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size)

       Link with -lgearman

DESCRIPTION

       gearman_job_st are passed to worker functions to represent jobs that are being run by gearman_worker_work().

       gearman_job_free() is used to free a job. This only needs to be done if a task was created with a preallocated structure.

       gearman_job_handle() returns the job handle(see gearman_job_handle_t for more information).

       gearman_job_function_name() return the name of the function that the job was set to execute against.

       gearman_job_unique() return the unique value that was used for gearman_job_st.

       returns the gearman_job_st workload. The size of it can be determined with gearman_job_workload_size().	gearman_job_take_workload() is the
       same as gearman_job_workload() with the exception that the result must be free(3) by the caller.

RETURN VALUE

       A value of gearman_return_t  is returned.  On success that value will be :c:type::GEARMAN_SUCCESS.   Use  gearman_strerror()  to  translate
       this value to a printable string.

HOME

       To find out more information please check: http://gearman.info/

SEE ALSO

       gearmand(8) libgearman(3)

AUTHOR

       Data Differential http://www.datadifferential.com/

COPYRIGHT

       2012, Data Differential, http://www.datadifferential.com/

0.33								   May 04, 2012 					       GEARMAN_JOB_FREE(3)