1GEARMAN_JOB_FREE_ALL(3)            Gearmand            GEARMAN_JOB_FREE_ALL(3)
2
3
4

NAME

6       gearman_job_free_all - Gearmand Documentation, http://gearman.info/
7

SYNOPSIS

9       #include <libgearman/gearman.h>
10
11       gearman_job_st
12
13       void gearman_job_free(gearman_job_st *job)
14
15       gearman_return_t    gearman_job_send_data(gearman_job_st *job,    const
16       void *data, size_t data_size)
17
18       gearman_return_t  gearman_job_send_warning(gearman_job_st *job,   const
19       void *warning, size_t warning_size)
20
21       gearman_return_t           gearman_job_send_status(gearman_job_st *job,
22       uint32_t numerator, uint32_t denominator)
23
24       gearman_return_t  gearman_job_send_complete(gearman_job_st *job,  const
25       void *result, size_t result_size)
26
27       gearman_return_t  gearman_job_send_exception(gearman_job_st *job, const
28       void *exception, size_t exception_size)
29
30       gearman_return_t gearman_job_send_fail(gearman_job_st *job)
31
32       const char *gearman_job_handle(const gearman_job_st *job)
33
34       const char *gearman_job_function_name(const gearman_job_st *job)
35
36       const char *gearman_job_unique(const gearman_job_st *job)
37
38       const void *gearman_job_workload(const gearman_job_st *job)
39
40       size_t gearman_job_workload_size(const gearman_job_st *job)
41
42       void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size)
43
44       gearman_client_st *gearman_job_use_client(gearman_job_st *job)
45
46       Link with -lgearman
47

DESCRIPTION

49       gearman_job_st are passed to worker functions to  represent  jobs  that
50       are being run by gearman_worker_work().
51
52       gearman_job_free() is used to free a job. This only needs to be done if
53       a task was created with a preallocated structure.
54
55       gearman_job_handle() returns the  job  handle(see  gearman_job_handle_t
56       for more information).
57
58       gearman_job_function_name()  return  the  name of the function that the
59       job was set to execute against.
60
61       gearman_job_unique()  return  the  unique  value  that  was  used   for
62       gearman_job_st.
63
64       gearman_job_take_workload returns the gearman_job_st workload. The size
65       of   it   can   be   determined    with    gearman_job_workload_size().
66       gearman_job_take_workload()  is the same as gearman_job_workload() with
67       the exception that the result must be free(3) by the caller.
68
69       gearman_job_use_client  returns  a  gearman_client_st  configured  from
70       gearman_job_st. The gearman_client_st can be used to communicate client
71       API commands to the server.  You do not, and  should  not,  call  gear‐
72       man_client_free()  on  the gearman_client_st. It is cleaned up when job
73       is cleaned up.
74

RETURN VALUE

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

HOME

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

SEE ALSO

84       gearmand(8) libgearman(3)
85

AUTHOR

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

90       2011-2014, Data Differential, http://www.datadifferential.com/
91
92
93
94
951.1.18                         December 11, 2017       GEARMAN_JOB_FREE_ALL(3)
Impressum