1GEARMAN_CLIENT_ST(3)               Gearmand               GEARMAN_CLIENT_ST(3)
2
3
4

NAME

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

SYNOPSIS

9       #include <libgearman/gearman.h>
10
11       type gearman_client_st
12
13       type gearman_task_context_free_fn
14
15       int gearman_client_timeout(gearman_client_st *client)
16
17       void gearman_client_set_timeout(gearman_client_st *client, int timeout)
18
19       void *gearman_client_context(const gearman_client_st *client)
20
21       void  gearman_client_set_context(gearman_client_st  *client, void *con‐
22       text)
23
24       void  gearman_client_set_workload_malloc_fn(gearman_client_st  *client,
25       gearman_malloc_fn *function, void *context)
26
27       Deprecated since version 0.23: Use gearman_allocator_t
28
29
30       void   gearman_client_set_workload_free_fn(gearman_client_st   *client,
31       gearman_free_fn *function, void *context)
32
33       Deprecated since version 0.23: Use gearman_allocator_t
34
35
36       void gearman_client_task_free_all(gearman_client_st *client)
37
38       void gearman_client_set_task_context_free_fn(gearman_client_st *client,
39       gearman_task_context_free_fn *function)
40
41       Link with -lgearman
42

DESCRIPTION

44       gearman_client_st is used for client communication with the server.
45
46       gearman_client_context()  and  gearman_client_set_context() can be used
47       to store an arbitrary object for the user.
48
49       gearman_client_set_task_context_free_fn() sets a trigger that  will  be
50       called when a gearman_task_st is released.
51
52       gearman_client_timeout()  and  gearman_client_set_timeout() get and set
53       the current connection timeout value, in milliseconds, for the client.
54
55       Normally malloc(3) and free(3) are used for  allocation  and  releasing
56       workloads.          gearman_client_set_workload_malloc_fn()         and
57       gearman_client_set_workload_free_fn() can be used to replace these with
58       custom functions. (These have been deprecated, please see gearman_allo‐
59       cator_t for the updated interface.
60
61       gearman_client_task_free_all()  is  used  to  free  all  current  gear‐
62       man_task_st that have been created with the gearman_client_st.
63
64       WARNING:
65          By calling gearman_client_task_free_all() you can end up with a SEG‐
66          FAULT if you try to use  any  gearman_task_st  that  you  have  kept
67          pointers too.
68

RETURN VALUE

70       gearman_client_timeout()  returns an integer representing the amount of
71       time in milliseconds to wait for a connection before throwing an error.
72       A value of -1 means an infinite timeout value.
73

HOME

75       To find out more information please check: http://gearman.info/
76
77       SEE ALSO:
78          gearmand(8) libgearman(3) gearman_client_create(3)
79

AUTHOR

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

84       2011-2014, Data Differential, http://www.datadifferential.com/
85
86
87
88
891.1.20                           Nov 19, 2022             GEARMAN_CLIENT_ST(3)
Impressum