|
480
by Brian Aker
Merge from build. |
1 |
.TH "GEARMAN_CLIENT_OPTIONS_T" "3" "January 13, 2012" "0.27" "Gearmand" |
|
436.1.4
by Brian Aker
Continue to extend to test for free in client (also added method for determining if it has been enabled). |
2 |
.SH NAME |
3 |
gearman_client_options_t \- Gearmand Documentation, http://gearman.info/
|
|
4 |
.
|
|
5 |
.nr rst2man-indent-level 0 |
|
6 |
.
|
|
7 |
.de1 rstReportMargin |
|
8 |
\\$1 \\n[an-margin] |
|
9 |
level \\n[rst2man-indent-level]
|
|
10 |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
11 |
- |
|
12 |
\\n[rst2man-indent0]
|
|
13 |
\\n[rst2man-indent1]
|
|
14 |
\\n[rst2man-indent2]
|
|
15 |
.. |
|
16 |
.de1 INDENT |
|
17 |
.\" .rstReportMargin pre: |
|
18 |
. RS \\$1 |
|
19 |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
|
20 |
. nr rst2man-indent-level +1 |
|
21 |
.\" .rstReportMargin post: |
|
22 |
.. |
|
23 |
.de UNINDENT |
|
24 |
. RE |
|
25 |
.\" indent \\n[an-margin] |
|
26 |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
27 |
.nr rst2man-indent-level -1 |
|
28 |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
29 |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
|
30 |
.. |
|
31 |
.\" Man page generated from reStructeredText. |
|
32 |
.
|
|
33 |
.SH SYNOPSIS |
|
34 |
.sp
|
|
35 |
#include <libgearman/gearman.h> |
|
36 |
.INDENT 0.0 |
|
37 |
.TP
|
|
38 |
.B gearman_client_options_t |
|
39 |
.UNINDENT
|
|
40 |
.INDENT 0.0 |
|
41 |
.TP
|
|
42 |
.B \fI\%gearman_client_options_t\fP gearman_client_options(const gearman_client_st\fI\ *client\fP) |
|
43 |
.UNINDENT
|
|
44 |
.INDENT 0.0 |
|
45 |
.TP
|
|
46 |
.B void gearman_client_set_options(gearman_client_st\fI\ *client\fP, \fI\%gearman_client_options_t\fP\fI\ options\fP) |
|
47 |
.UNINDENT
|
|
48 |
.INDENT 0.0 |
|
49 |
.TP
|
|
50 |
.B void gearman_client_add_options(gearman_client_st\fI\ *client\fP, \fI\%gearman_client_options_t\fP\fI\ options\fP) |
|
51 |
.UNINDENT
|
|
52 |
.INDENT 0.0 |
|
53 |
.TP
|
|
54 |
.B void gearman_client_remove_options(gearman_client_st\fI\ *client\fP, \fI\%gearman_client_options_t\fP\fI\ options\fP) |
|
55 |
.UNINDENT
|
|
56 |
.INDENT 0.0 |
|
57 |
.TP
|
|
58 |
.B bool gearman_client_has_option(gearman_client_st\fI\ *client\fP, \fI\%gearman_client_options_t\fP\fI\ option\fP) |
|
59 |
.UNINDENT
|
|
60 |
.sp
|
|
61 |
Link with \-lgearman
|
|
62 |
.SH DESCRIPTION |
|
63 |
.sp
|
|
64 |
\fI\%gearman_client_options()\fP returns the \fI\%gearman_client_options_t\fP for \fBgearman_client_st\fP. You enable options via \fI\%gearman_client_add_options()\fP and disable options via \fI\%gearman_client_remove_options()\fP. |
|
65 |
.sp
|
|
66 |
\fI\%gearman_client_set_options()\fP has been DEPRECATED. |
|
67 |
.sp
|
|
68 |
The currently supported options are: |
|
69 |
.INDENT 0.0 |
|
70 |
.TP
|
|
71 |
.B GEARMAN_CLIENT_NON_BLOCKING |
|
72 |
.UNINDENT
|
|
73 |
.sp
|
|
74 |
Run the cient in a non\-blocking mode.
|
|
75 |
.INDENT 0.0 |
|
76 |
.TP
|
|
77 |
.B GEARMAN_CLIENT_FREE_TASKS |
|
78 |
.UNINDENT
|
|
79 |
.sp
|
|
80 |
Automatically free task objects once they are complete. |
|
81 |
.INDENT 0.0 |
|
82 |
.TP
|
|
83 |
.B GEARMAN_CLIENT_UNBUFFERED_RESULT |
|
84 |
.UNINDENT
|
|
85 |
.sp
|
|
86 |
Allow the client to read data in chunks rather than have the library buffer |
|
87 |
the entire data result and pass that back. |
|
88 |
.SH RETURN VALUE |
|
89 |
.sp
|
|
90 |
Various |
|
91 |
.SH HOME |
|
92 |
.sp
|
|
93 |
To find out more information please check: |
|
94 |
\fI\%http://gearman.info/\fP |
|
|
441.1.13
by Brian Aker
Update docs |
95 |
.IP "See also" |
|
436.1.4
by Brian Aker
Continue to extend to test for free in client (also added method for determining if it has been enabled). |
96 |
.sp
|
97 |
\fIgearmand(8)\fP \fIlibgearman(3)\fP |
|
98 |
.RE
|
|
99 |
.SH AUTHOR |
|
100 |
Data Differential http://datadifferential.com/ |
|
101 |
.SH COPYRIGHT |
|
102 |
2011, Data Differential, http://datadifferential.com/ |
|
103 |
.\" Generated by docutils manpage writer. |
|
104 |
.\" |
|
105 |
.
|