1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
.TH "GEARMAN_CLIENT_CLONE" "3" "May 04, 2012" "0.33" "Gearmand"
.SH NAME
gearman_client_clone \- Gearmand Documentation, http://gearman.info/
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
#include <libgearman/gearman.h>
.INDENT 0.0
.TP
.B gearman_client_st *gearman_client_create(gearman_client_st\fI\ *client\fP)
.UNINDENT
.INDENT 0.0
.TP
.B gearman_client_st *gearman_client_clone(gearman_client_st\fI\ *client\fP, const gearman_client_st\fI\ *from\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void gearman_client_free(gearman_client_st\fI\ *client\fP)
.UNINDENT
.sp
Link with \-lgearman
.SH DESCRIPTION
.sp
\fI\%gearman_client_create()\fP is used to create a c:type:\fIgearman_client_st\fP structure that will then
be used by other libgearman client functions to communicate with the server. You
should either pass a statically declared \fBgearman_client_st\fP to \fI\%gearman_client_create()\fP or
a NULL. If a NULL passed in then a structure is allocated for you.
.sp
\fI\%gearman_client_clone()\fP is similar to \fI\%gearman_client_create()\fP but it copies the
defaults and list of servers from the source \fBgearman_client_st\fP . If you pass a null as
the argument for the source to clone, it is the same as a call to gearman_client_create.
If the destination argument is NULL a \fBgearman_client_st\fP will be allocated for you.
.sp
To clean up memory associated with a \fBgearman_client_st\fP structure you should pass
it to gearman_client_free when you are finished using it. \fI\%gearman_client_free()\fP is
the only way to make sure all memory is deallocated when you finish using
the structure.
.IP Warning
You may wish to avoid using \fI\%gearman_client_create()\fP or \fI\%gearman_client_clone()\fP with a
stack based allocation, ie the first parameter. The most common issues related to ABI safety involve
stack allocated structures.
.RE
.SH RETURN VALUE
.sp
\fI\%gearman_client_create\fP returns a pointer to the gearman_client_st
that was created (or initialized). On an allocation failure, it returns
NULL.
.sp
\fI\%gearman_client_clone\fP returns a pointer to the gearman_client_st that was created
(or initialized). On an allocation failure, it returns NULL.
.SH HOME
.sp
To find out more information please check:
\fI\%http://gearman.info/\fP
.IP "See also"
.sp
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_strerror(3)\fP \fIgearman_client_st(3)\fP
.RE
.SH AUTHOR
Data Differential http://www.datadifferential.com/
.SH COPYRIGHT
2012, Data Differential, http://www.datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
|
