gearman_worker_free(3) [debian man page]

GEARMAN_WORKER_FREE(3)						     Gearmand						    GEARMAN_WORKER_FREE(3)

NAME

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

SYNOPSIS

       #include <libgearman/gearman.h>

       gearman_worker_st *gearman_worker_create(gearman_worker_st *client)

       gearman_worker_st *gearman_worker_clone(gearman_worker_st *client, const gearman_worker_st *from)

       void gearman_worker_free(gearman_worker_st *client)

       Link with -lgearman

DESCRIPTION

       gearman_worker_create()	is used to create a gearman_worker_st  structure that will then be used by other libgearman(3) client functions to
       communicate with the server. You should either pass a statically declared gearman_worker_st  to gearman_worker_create) or a NULL. If a NULL
       passed in then a structure is allocated for you.

       gearman_worker_clone()  is  similar  to	gearman_worker_create()  but  it  copies  the  defaults  and list of servers from the source gear-
       man_worker_st. If you pass a null as the argument for the source to clone, it is the same as a call  to	gearman_worker_create().   If  the
       destination argument is NULL a gearman_worker_st  will be allocated for you.

       To  clean  up memory associated with a gearman_worker_st  structure you should pass it to gearman_worker_free() when you are finished using
       it. gearman_worker_free is the only way to make sure all memory is deallocated when you finish using the structure.

       You may wish to avoid using gearman_worker_create() or gearman_worker_clone() with a stack based allocation, ie the  first  parameter.  The
       most common issues related to ABI safety involve heap allocated structures.

RETURN VALUE

       gearman_worker_create()	returns a pointer to the gearman_worker_st that was created (or initialized). On an allocation failure, it returns
       NULL.

       gearman_worker_clone() returns a pointer to the gearman_worker_st that was created (or initialized). On an allocation failure,  it  returns
       NULL.

HOME

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

       See also

	      gearmand(8) libgearman(3) gearman_strerror(3)

AUTHOR

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

COPYRIGHT

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

0.33								   May 04, 2012 					    GEARMAN_WORKER_FREE(3)

GEARMAN_WORKER_ST(3)						     Gearmand						      GEARMAN_WORKER_ST(3)

NAME

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

SYNOPSIS

       #include <libgearman/gearman.h>

       gearman_worker_st

       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)

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

       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)

       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.

       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

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

0.33								   May 04, 2012 					      GEARMAN_WORKER_ST(3)