← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_worker_options.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_worker_options.3
1
 
.TH "GEARMAN_WORKER_OPTIONS" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_worker_options \- 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_worker_options_t
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B \fI\%gearman_worker_options_t\fP gearman_worker_options(const gearman_worker_st\fI\ *worker\fP)
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B void gearman_worker_add_options(gearman_worker_st\fI\ *worker\fP, \fI\%gearman_worker_options_t\fP\fI\ options\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B void gearman_worker_remove_options(gearman_worker_st\fI\ *worker\fP, \fI\%gearman_worker_options_t\fP\fI\ options\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B void gearman_worker_set_options(gearman_worker_st\fI\ *worker\fP, \fI\%gearman_worker_options_t\fP\fI\ options\fP)
55
 
.UNINDENT
56
 
.sp
57
 
Deprecated since version 0.21.
58
 
.SH DESCRIPTION
59
 
.sp
60
 
\fI\%gearman_worker_options()\fP returns the \fI\%gearman_worker_options_t\fP for \fBgearman_worker_st\fP. You enable options via \fI\%gearman_worker_add_options()\fP and disable options via \fI\%gearman_worker_remove_options()\fP.
61
 
.sp
62
 
The currently supported options are:
63
 
.sp
64
 
Enable non\-block IO for the worker.
65
 
.INDENT 0.0
66
 
.TP
67
 
.B GEARMAN_WORKER_GRAB_UNIQ
68
 
.UNINDENT
69
 
.sp
70
 
Only grab jobs that have been assigned unique values. This is useful for workers who only want to worker with background jobs.
71
 
.INDENT 0.0
72
 
.TP
73
 
.B GEARMAN_WORKER_TIMEOUT_RETURN
74
 
.UNINDENT
75
 
.sp
76
 
Has a return timeout been set for the worker.
77
 
.SH RETURN VALUE
78
 
.sp
79
 
Various
80
 
.SH HOME
81
 
.sp
82
 
To find out more information please check:
83
 
\fI\%http://gearman.info/\fP
84
 
.IP "See also"
85
 
.sp
86
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP
87
 
.RE
88
 
.SH AUTHOR
89
 
Data Differential http://www.datadifferential.com/
90
 
.SH COPYRIGHT
91
 
2012, Data Differential, http://www.datadifferential.com/
92
 
.\" Generated by docutils manpage writer.
93
 
.\" 
94
 
.