1GEARMAN_CLIENT_FREE(3)             Gearmand             GEARMAN_CLIENT_FREE(3)
2
3
4

NAME

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

SYNOPSIS

9       #include <libgearman/gearman.h>
10
11       gearman_client_st *gearman_client_create(gearman_client_st *client)
12
13       gearman_client_st    *gearman_client_clone(gearman_client_st   *client,
14       const gearman_client_st *from)
15
16       void gearman_client_free(gearman_client_st *client)
17
18       Link with -lgearman
19

DESCRIPTION

21       gearman_client_create() is used to  create  a  c:type:gearman_client_st
22       structure  that  will then be used by other libgearman client functions
23       to communicate with the server. You should either pass a statically de‐
24       clared  gearman_client_st   to  gearman_client_create() or a NULL. If a
25       NULL passed in then a structure is allocated for you.
26
27       gearman_client_clone() is similar  to  gearman_client_create()  but  it
28       copies  the  defaults  and  list  of  servers  from  the  source  gear‐
29       man_client_st . If you pass a null as the argument for  the  source  to
30       clone,  it is the same as a call to gearman_client_create.  If the des‐
31       tination argument is NULL a gearman_client_st  will  be  allocated  for
32       you.
33
34       To  clean  up memory associated with a gearman_client_st  structure you
35       should pass it to gearman_client_free when you are finished  using  it.
36       gearman_client_free()  is  the  only way to make sure all memory is de‐
37       allocated when you finish using the structure.
38
39       WARNING:
40          You   may   wish   to   avoid   using   gearman_client_create()   or
41          gearman_client_clone()  with  a stack based allocation, ie the first
42          parameter. The most common issues  related  to  ABI  safety  involve
43          stack allocated structures.
44

RETURN VALUE

46       gearman_client_create  returns  a pointer to the gearman_client_st that
47       was created (or initialized). On  an  allocation  failure,  it  returns
48       NULL.
49
50       gearman_client_clone  returns  a  pointer to the gearman_client_st that
51       was created (or initialized). On  an  allocation  failure,  it  returns
52       NULL.
53

HOME

55       To find out more information please check: http://gearman.info/
56
57       SEE ALSO:
58          gearmand(8) libgearman(3) gearman_strerror(3) gearman_client_st(3)
59

AUTHOR

61       Data Differential http://www.datadifferential.com/
62
64       2011-2014, Data Differential, http://www.datadifferential.com/
65
66
67
68
691.1.20                           Nov 19, 2022           GEARMAN_CLIENT_FREE(3)
Impressum