1GEARMAN_JOB_TAKE_WORKLOAD(3)       Gearmand       GEARMAN_JOB_TAKE_WORKLOAD(3)
2
3
4

NAME

6       gearman_job_take_workload   -   Gearmand   Documentation,  http://gear‐
7       man.info/
8

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUE

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

HOME

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

SEE ALSO

85       gearmand(8) libgearman(3)
86

AUTHOR

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

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