NAME

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

SYNOPSIS

       #include <libgearman/gearman.h>

       type gearman_worker_st

       type gearman_worker_set_task_context_free_fn

       int gearman_worker_timeout(gearman_worker_st *worker)

       void gearman_worker_set_timeout(gearman_worker_st *worker, int timeout)

       void *gearman_worker_context(const gearman_worker_st *worker)

       void gearman_worker_set_context(gearman_worker_st *worker, void *context)

       void  gearman_worker_set_workload_malloc_fn(gearman_worker_st  *worker,  gearman_malloc_fn
       *function, void *context)

       void   gearman_worker_set_workload_free_fn(gearman_worker_st   *worker,    gearman_free_fn
       *function, void *context)

       gearman_return_t gearman_worker_wait(gearman_worker_st *worker)

       gearman_return_t    gearman_worker_register(gearman_worker_st    *worker,    const    char
       *function_name, uint32_t timeout)

       gearman_return_t   gearman_worker_unregister(gearman_worker_st   *worker,    const    char
       *function_name)

       gearman_return_t gearman_worker_unregister_all(gearman_worker_st *worker)

       void gearman_job_free_all(gearman_worker_st *worker)

       bool  gearman_worker_function_exist(gearman_worker_st  *worker, const char *function_name,
       size_t function_length)

       gearman_return_t gearman_worker_work(gearman_worker_st *worker)

       gearman_job_st *gearman_worker_grab_job(gearman_worker_st  *worker,  gearman_job_st  *job,
       gearman_return_t *ret_ptr)

       Link with -lgearman

DESCRIPTION

       gearman_worker_st is used for worker communication with the server.

       gearman_worker_context()   and  gearman_worker_set_context()  can  be  used  to  store  an
       arbitrary object for the user.

       gearman_worker_set_task_context_free_fn() sets a  trigger  that  will  be  called  when  a
       gearman_task_st is released.

       gearman_worker_timeout()  and gearman_worker_set_timeout() get and set the current timeout
       value, in milliseconds, for the worker.

       gearman_worker_function_exist() is used to determine if a  given  worker  has  a  specific
       function.

       gearman_worker_work() have the worker execute against jobs until an error occurs.

       gearman_worker_grab_job()   Takes   a  job  from  one  of  the  job  servers.  It  is  the
       responsibility of the caller to free the job once they are done. This interface is used in
       testing, and is very rarely the correct interface to program against.

       Normally   malloc(3)  and  free(3)  are  used  for  allocation  and  releasing  workloads.
       gearman_worker_set_workload_malloc_fn() and gearman_worker_set_workload_free_fn()  can  be
       used to replace these with custom functions.

       If   you   need   to   remove   a   function   from   the   server  you  can  call  either
       gearman_worker_unregister_all() to remove all functions  that  the  worker  has  told  the
       gearmand  server about, or you can use gearman_worker_unregister() to remove just a single
       function.

RETURN

       Various

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

       2011-2024, Data Differential, http://www.datadifferential.com/