← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_client_set_status_fn.3

  • Committer: Brian Aker
  • Date: 2012-09-30 23:55:03 UTC
  • mto: (621.4.21 workspace)
  • mto: This revision was merged to the branch mainline in revision 656.
  • Revision ID: brian@tangent.org-20120930235503-u6r0uq1hl0mdj5an
Fix it so that we don't need to store the manpages in the tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/gearman_client_set_status_fn.3
1
 
.TH "GEARMAN_CLIENT_SET_STATUS_FN" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_client_set_status_fn \- 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_actions_t
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B gearman_workload_fn
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B gearman_created_fn
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B gearman_data_fn
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B gearman_warning_fn
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B gearman_universal_status_fn
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B gearman_exception_fn
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B gearman_fail_fn
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B gearman_complete_fn
71
 
.UNINDENT
72
 
.INDENT 0.0
73
 
.TP
74
 
.B void gearman_client_set_workload_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_workload_fn\fP\fI\ *function\fP)
75
 
.UNINDENT
76
 
.INDENT 0.0
77
 
.TP
78
 
.B void gearman_client_set_created_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_created_fn\fP\fI\ *function\fP)
79
 
.UNINDENT
80
 
.INDENT 0.0
81
 
.TP
82
 
.B void gearman_client_set_data_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_data_fn\fP\fI\ *function\fP)
83
 
.UNINDENT
84
 
.INDENT 0.0
85
 
.TP
86
 
.B void gearman_client_set_warning_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_warning_fn\fP\fI\ *function\fP)
87
 
.UNINDENT
88
 
.INDENT 0.0
89
 
.TP
90
 
.B void gearman_client_set_status_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_universal_status_fn\fP\fI\ *function\fP)
91
 
.UNINDENT
92
 
.INDENT 0.0
93
 
.TP
94
 
.B void gearman_client_set_complete_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_complete_fn\fP\fI\ *function\fP)
95
 
.UNINDENT
96
 
.INDENT 0.0
97
 
.TP
98
 
.B void gearman_client_set_exception_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_exception_fn\fP\fI\ *function\fP)
99
 
.UNINDENT
100
 
.INDENT 0.0
101
 
.TP
102
 
.B void gearman_client_set_fail_fn(gearman_client_st\fI\ *client\fP, \fI\%gearman_fail_fn\fP\fI\ *function\fP)
103
 
.UNINDENT
104
 
.INDENT 0.0
105
 
.TP
106
 
.B void gearman_client_clear_fn(gearman_client_st\fI\ *client\fP)
107
 
.UNINDENT
108
 
.INDENT 0.0
109
 
.TP
110
 
.B const char *gearman_client_do_job_handle(gearman_client_st\fI\ *client\fP)
111
 
.UNINDENT
112
 
.sp
113
 
Link to \-lgearman
114
 
.SH DESCRIPTION
115
 
.sp
116
 
Callbacks for client execution task states.
117
 
.sp
118
 
\fI\%gearman_client_set_data_fn()\fP sets the callback function that will
119
 
be called if server is to make a request to the client to provide more data.
120
 
.sp
121
 
\fI\%gearman_client_do_job_handle()\fP gest the job handle for the running task. This should be used between repeated
122
 
\fBgearman_client_do()\fP (and related) calls to get information.
123
 
.sp
124
 
\fI\%gearman_client_clear_fn()\fP can be called to remove all existing
125
 
\fI\%gearman_actions_t\fP that have been set.
126
 
.sp
127
 
\fI\%gearman_client_set_created_fn()\fP,
128
 
\fI\%gearman_client_set_data_fn()\fP,
129
 
\fI\%gearman_client_set_warning_fn()\fP,
130
 
\fI\%gearman_client_set_status_fn()\fP,
131
 
\fI\%gearman_client_set_complete_fn()\fP,
132
 
\fI\%gearman_client_set_exception_fn()\fP, and
133
 
\fI\%gearman_client_set_fail_fn()\fP, set callback functions for the
134
 
different states of execution for a client request. Each request, ie
135
 
a creation of \fBgearman_task_st\fP, keeps a copy of callbacks when it
136
 
is created.
137
 
.sp
138
 
\fI\%gearman_client_set_exception_fn()\fP will only be called if exceptions are enabled on the server. You can do this by calling \fBgearman_client_set_server_option()\fP.
139
 
.sp
140
 
An example of this:
141
 
.sp
142
 
.nf
143
 
.ft C
144
 
const char *EXCEPTIONS="exceptions";
145
 
gearman_client_set_server_option(client, EXCEPTIONS, strlen(EXCEPTIONS));
146
 
.ft P
147
 
.fi
148
 
.SH RETURN VALUE
149
 
.sp
150
 
None
151
 
.IP "See also"
152
 
.RE
153
 
.sp
154
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_error(3)\fP or \fIgearman_worker_error(3)\fP
155
 
.SH AUTHOR
156
 
Data Differential http://www.datadifferential.com/
157
 
.SH COPYRIGHT
158
 
2012, Data Differential, http://www.datadifferential.com/
159
 
.\" Generated by docutils manpage writer.
160
 
.\" 
161
 
.