← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_worker_set_timeout.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_set_timeout.3
1
 
.TH "GEARMAN_WORKER_SET_TIMEOUT" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_worker_set_timeout \- 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_st
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B gearman_worker_set_task_context_free_fn
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B int gearman_worker_timeout(\fI\%gearman_worker_st\fP\fI\ *worker\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B void gearman_worker_set_timeout(\fI\%gearman_worker_st\fP\fI\ *worker\fP, int\fI\ timeout\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B void *gearman_worker_context(const \fI\%gearman_worker_st\fP\fI\ *worker\fP)
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B void gearman_worker_set_context(\fI\%gearman_worker_st\fP\fI\ *worker\fP, void\fI\ *context\fP)
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B void gearman_worker_set_workload_malloc_fn(\fI\%gearman_worker_st\fP\fI\ *worker\fP, gearman_malloc_fn\fI\ *function\fP, void\fI\ *context\fP)
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B void gearman_worker_set_workload_free_fn(\fI\%gearman_worker_st\fP\fI\ *worker\fP, gearman_free_fn\fI\ *function\fP, void\fI\ *context\fP)
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B gearman_return_t gearman_worker_wait(\fI\%gearman_worker_st\fP\fI\ *worker\fP)
71
 
.UNINDENT
72
 
.INDENT 0.0
73
 
.TP
74
 
.B gearman_return_t gearman_worker_register(\fI\%gearman_worker_st\fP\fI\ *worker\fP, const char\fI\ *function_name\fP, uint32_t\fI\ timeout\fP)
75
 
.UNINDENT
76
 
.INDENT 0.0
77
 
.TP
78
 
.B gearman_return_t gearman_worker_unregister(\fI\%gearman_worker_st\fP\fI\ *worker\fP, const char\fI\ *function_name\fP)
79
 
.UNINDENT
80
 
.INDENT 0.0
81
 
.TP
82
 
.B gearman_return_t gearman_worker_unregister_all(\fI\%gearman_worker_st\fP\fI\ *worker\fP)
83
 
.UNINDENT
84
 
.INDENT 0.0
85
 
.TP
86
 
.B gearman_job_st *gearman_worker_grab_job(\fI\%gearman_worker_st\fP\fI\ *worker\fP, gearman_job_st\fI\ *job\fP, gearman_return_t\fI\ *ret_ptr\fP)
87
 
.UNINDENT
88
 
.INDENT 0.0
89
 
.TP
90
 
.B void gearman_job_free_all(\fI\%gearman_worker_st\fP\fI\ *worker\fP)
91
 
.UNINDENT
92
 
.INDENT 0.0
93
 
.TP
94
 
.B bool gearman_worker_function_exist(\fI\%gearman_worker_st\fP\fI\ *worker\fP, const char\fI\ *function_name\fP, size_t\fI\ function_length\fP)
95
 
.UNINDENT
96
 
.INDENT 0.0
97
 
.TP
98
 
.B gearman_return_t gearman_worker_work(\fI\%gearman_worker_st\fP\fI\ *worker\fP)
99
 
.UNINDENT
100
 
.sp
101
 
Link with \-lgearman
102
 
.SH DESCRIPTION
103
 
.sp
104
 
\fI\%gearman_worker_st\fP is used for worker communication with the server.
105
 
.sp
106
 
\fI\%gearman_worker_context()\fP and \fI\%gearman_worker_set_context()\fP can be used to store an arbitrary object for the user.
107
 
.sp
108
 
\fI\%gearman_worker_set_task_context_free_fn()\fP sets a trigger that will be called when a \fBgearman_task_st\fP is released.
109
 
.sp
110
 
\fI\%gearman_worker_timeout()\fP and \fI\%gearman_worker_set_timeout()\fP get and set the current timeout value, in milliseconds, for the worker.
111
 
.sp
112
 
\fI\%gearman_worker_function_exist()\fP is used to determine if a given worker has a specific function.
113
 
.sp
114
 
Normally \fImalloc(3)\fP and \fIfree(3)\fP are used for allocation and releasing workloads. \fI\%gearman_worker_set_workload_malloc_fn()\fP and \fI\%gearman_worker_set_workload_free_fn()\fP can be used to replace these with custom functions.
115
 
.sp
116
 
If you need to remove a function from the server you can call either \fI\%gearman_worker_unregister_all()\fP to remove all functions that the worker has told the \fBgearmand\fP server about, or you can use \fI\%gearman_worker_unregister()\fP to remove just a single function.
117
 
.SH RETURN
118
 
.sp
119
 
Various
120
 
.SH HOME
121
 
.sp
122
 
To find out more information please check:
123
 
\fI\%http://gearman.info/\fP
124
 
.SH SEE ALSO
125
 
.sp
126
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP
127
 
.SH AUTHOR
128
 
Data Differential http://www.datadifferential.com/
129
 
.SH COPYRIGHT
130
 
2012, Data Differential, http://www.datadifferential.com/
131
 
.\" Generated by docutils manpage writer.
132
 
.\" 
133
 
.