1GEARMAN_ACTIONS_T(3)               Gearmand               GEARMAN_ACTIONS_T(3)
2
3
4

NAME

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

SYNOPSIS

9       #include <libgearman/gearman.h>
10
11       type gearman_actions_t
12
13       type gearman_workload_fn
14
15       type gearman_created_fn
16
17       type gearman_data_fn
18
19       type gearman_warning_fn
20
21       type gearman_universal_status_fn
22
23       type gearman_exception_fn
24
25       type gearman_fail_fn
26
27       type gearman_complete_fn
28
29       void      gearman_client_set_workload_fn(gearman_client_st     *client,
30       gearman_workload_fn *function)
31
32       void      gearman_client_set_created_fn(gearman_client_st      *client,
33       gearman_created_fn *function)
34
35       void        gearman_client_set_data_fn(gearman_client_st       *client,
36       gearman_data_fn *function)
37
38       void      gearman_client_set_warning_fn(gearman_client_st      *client,
39       gearman_warning_fn *function)
40
41       void       gearman_client_set_status_fn(gearman_client_st      *client,
42       gearman_universal_status_fn *function)
43
44       void     gearman_client_set_complete_fn(gearman_client_st      *client,
45       gearman_complete_fn *function)
46
47       void     gearman_client_set_exception_fn(gearman_client_st     *client,
48       gearman_exception_fn *function)
49
50       void       gearman_client_set_fail_fn(gearman_client_st        *client,
51       gearman_fail_fn *function)
52
53       void gearman_client_clear_fn(gearman_client_st *client)
54
55       const char *gearman_client_do_job_handle(gearman_client_st *client)
56
57       Link to -lgearman
58

DESCRIPTION

60       Callbacks for client execution task states.
61
62       gearman_client_set_data_fn()  sets  the  callback function that will be
63       called if server is to make a request to the  client  to  provide  more
64       data.
65
66       gearman_client_do_job_handle()  gest  the  job  handle  for the running
67       task. This should be used between repeated gearman_client_do() (and re‐
68       lated) calls to get information.
69
70       gearman_client_clear_fn()   can   be  called  to  remove  all  existing
71       gearman_actions_t that have been set.
72
73       gearman_client_set_created_fn(),          gearman_client_set_data_fn(),
74       gearman_client_set_warning_fn(),        gearman_client_set_status_fn(),
75       gearman_client_set_complete_fn(),    gearman_client_set_exception_fn(),
76       and  gearman_client_set_fail_fn(),  set callback functions for the dif‐
77       ferent states of execution for a client request.  Each  request,  ie  a
78       creation  of gearman_task_st, keeps a copy of callbacks when it is cre‐
79       ated.
80
81       gearman_client_set_exception_fn() will only be called if exceptions are
82       enabled   on   the   server.   You   can   do  this  by  calling  gear‐
83       man_client_set_server_option().
84
85       An example of this:
86
87          const char *EXCEPTIONS="exceptions";
88          gearman_client_set_server_option(client, EXCEPTIONS, strlen(EXCEPTIONS));
89

RETURN VALUE

91       None
92
93       SEE ALSO:
94          gearmand(8)   libgearman(3)   gearman_client_error(3)    or    gear‐
95          man_worker_error(3)
96

AUTHOR

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

101       2011-2014, Data Differential, http://www.datadifferential.com/
102
103
104
105
1061.1.20                           Nov 19, 2022             GEARMAN_ACTIONS_T(3)
Impressum