1
.TH "GEARMAN_CONTINUE" "3" "December 15, 2011" "0.26" "Gearmand"
3
gearman_continue \- Gearmand Documentation, http://gearman.info/
5
.nr rst2man-indent-level 0
9
level \\n[rst2man-indent-level]
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17
.\" .rstReportMargin pre:
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
. nr rst2man-indent-level +1
21
.\" .rstReportMargin post:
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
31
.\" Man page generated from reStructeredText.
35
#include <libgearman/gearman.h>
42
.B const char *gearman_strerror(\fI\%gearman_return_t\fP\fI\ rc\fP)
46
.B bool gearman_success(\fI\%gearman_return_t\fP\fI\ rc\fP)
50
.B bool gearman_failed(\fI\%gearman_return_t\fP\fI\ rc\fP)
54
.B bool gearman_continue(\fI\%gearman_return_t\fP\fI\ rc\fP)
57
Compile and link with \-lgearman
60
\fI\%gearman_return_t\fP is used as a return/error type for all calls using \fBgearman_client_st\fP and \fBgearman_worker_st\fP.
61
\fI\%GEARMAN_SUCCESS\fP is returned upon success, otherwise an error is returned. \fI\%gearman_failed()\fP can be used to see if the return value is a failing value.
62
You can print a text version of the error message with \fI\%gearman_strerror()\fP.
64
\fI\%gearman_success()\fP return true if \fI\%GEARMAN_SUCCESS\fP or if
65
\fI\%GEARMAN_NO_PENDING_TASKS\fP tests true.
67
\fI\%gearman_failed()\fP return true if any value other then \fI\%GEARMAN_SUCCESS\fP was provided.
69
\fI\%gearman_continue()\fP returns true if any error related to non\-blocking IO
70
occurred. This should be used for testing loops.
71
.SS Possible values of \fI\%gearman_return_t\fP:
79
.B GEARMAN_NO_PENDING_TASKS
80
\fBgearman_client_run_tasks()\fP was called and it has completed all tasks assigned to the client.
85
Blocking IO was found. gearman_continue() can be used to test for this.
90
System error occurred. Use either \fBgearman_client_errno()\fP or \fBgearman_worker_errno()\fP
94
.B GEARMAN_NO_ACTIVE_FDS
95
No active connections were available. gearman_continue() can be used to test for this.
99
.B GEARMAN_GETADDRINFO
100
Name resolution failed for a host.
104
.B GEARMAN_NO_SERVERS
105
No servers have been provided for the client/worker.
109
.B GEARMAN_LOST_CONNECTION
110
Connection was lost to the given server.
114
.B GEARMAN_MEMORY_ALLOCATION_FAILURE
115
Memory allocation failed.
119
.B GEARMAN_SERVER_ERROR
120
An error occurred on the server.
124
.B GEARMAN_NOT_CONNECTED
125
Client/Worker is not currently connected to the server.
129
.B GEARMAN_COULD_NOT_CONNECT
130
Server name was valid, but a connection could not be made.
134
.B GEARMAN_ECHO_DATA_CORRUPTION
135
Either \fBgearman_client_echo()\fP or \fBgearman_work_echo()\fP echo was unsuccessful because the data was returned from \fBgearmand\fP corrupted.
139
.B GEARMAN_UNKNOWN_STATE
140
The gearman_return_t was never set.
144
.B GEARMAN_FLUSH_DATA
145
Internal state, should never be seen by either client or worker.
149
.B GEARMAN_SEND_BUFFER_TOO_SMALL
150
Send buffer was too small.
155
A timeout occurred when making a request to the server.
159
.B GEARMAN_ARGUMENT_TOO_LARGE
160
Argument was too large for the current buffer.
164
.B GEARMAN_INVALID_ARGUMENT
165
One of the arguments to the given API call was invalid. EINVAL will be set if \fBgearman_client_error()\fP or \fBgearman_worker_error()\fP were not settable. This can also be returned if \fBGEARMAN_CLIENT_UNBUFFERED_RESULT\fP was set, but the client is not handling the data correctly.
170
.B GEARMAN_NEED_WORKLOAD_FN
171
A client was asked for work, but no \fBgearman_workload_fn\fP callback was specified. See \fBgearman_client_set_workload_fn()\fP
176
A task has failed, and the worker has exited with an error or it called \fBgearman_job_send_fail()\fP
180
.B GEARMAN_IN_PROGRESS
181
\fBgearman_client_job_status()\fP has been called for a \fBgearman_job_handle_t\fP and the Job is currently being run by a worker.
185
.B GEARMAN_JOB_EXISTS
186
\fBgearman_client_job_status()\fP has been called for a \fBgearman_job_handle_t\fP and the Job is currently known by a server, but is not being run by a worker.
191
.B GEARMAN_INVALID_FUNCTION_NAME
192
A worker was sent a request for a job that it did not have a valid function for.
196
.B GEARMAN_INVALID_WORKER_FUNCTION
197
No callback was provided by the worker for a given function.
201
.B GEARMAN_NO_REGISTERED_FUNCTION
202
A request for removing a given function from a worker was invalid since that function did not exist.
206
.B GEARMAN_NO_REGISTERED_FUNCTIONS
207
The worker has not registered any functions.
212
No jobs were found for the worker.
216
Client which have registed a custom \fBgearman_actions_t\fP may use these
217
value as return values to the calling client.
221
Worker has sent a chunked piece of data to the client via \fBgearman_job_send_data()\fP
225
.B GEARMAN_WORK_WARNING
226
Worker has issued a warning to the client via \fBgearman_job_send_warning()\fP
230
.B GEARMAN_WORK_STATUS
231
Status has been updated by the worker via \fBgearman_job_send_status()\fP
235
.B GEARMAN_WORK_EXCEPTION
236
Worker has sent an exception the client via \fBgearman_job_send_exception()\fP
241
A task has failed, and the worker has exited with an error or it called \fBgearman_job_send_fail()\fP
245
.B GEARMAN_WORK_ERROR
246
A task has had an error and will be retried.
251
Used only in custom application for client return based on \fI\%GEARMAN_WORK_DATA\fP, \fI\%GEARMAN_WORK_WARNING\fP, \fI\%GEARMAN_WORK_EXCEPTION\fP, \fI\%GEARMAN_WORK_FAIL\fP, or \fI\%GEARMAN_WORK_STATUS\fP. \fI\%gearman_continue()\fP can be used to check for this value.
255
Any function defined by \fBgearman_worker_define_function()\fP may, and can only, return the following \fI\%gearman_return_t\fP values.
259
The function successfully completed the job.
264
The function failed to complete the job.
269
A task has had an error and will be retried.
274
\fI\%GEARMAN_SHUTDOWN\fP is a special case. If it is returned the client will be sent \fI\%GEARMAN_SUCCESS\fP, but \fBgearman_worker_work()\fP will exit with \fI\%GEARMAN_SHUTDOWN\fP.
279
.B GEARMAN_NOT_FLUSHING
280
\fBgearman_task_send_workload()\fP failed, it was not in the correct state.
284
.B GEARMAN_DATA_TOO_LARGE
285
\fBgearman_task_send_workload()\fP failed, the data was too large to be sent.
289
If any of these errors occurred the connection will be dropped/reset.
292
.B GEARMAN_INVALID_MAGIC
296
.B GEARMAN_INVALID_COMMAND
300
.B GEARMAN_INVALID_PACKET
304
.B GEARMAN_UNEXPECTED_PACKET
308
.B GEARMAN_TOO_MANY_ARGS
312
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_error()\fP or \fIgearman_worker_error()\fP
314
Data Differential http://datadifferential.com/
316
2011, Data Differential, http://datadifferential.com/
317
.\" Generated by docutils manpage writer.
added
removed
docs/man/gearman_continue.3
