← Back to branch summary

~clint-fewbar/ubuntu/precise/gearmand/drop-unneeded-patches

« back to all changes in this revision

Viewing changes to docs/man/gearman_worker_register.3

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen, Michael Fladischer, Stig Sandbeck Mathisen
  • Date: 2012-01-23 11:31:08 UTC
  • mfrom: (6.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20120123113108-wl1yhiba13q9jusb
Tags: 0.27-1
http://bugs.debian.org/621486
https://launchpad.net/bugs/682680
[Michael Fladischer]
* Patch: fix spelling
* Patch: remove dependency on googleanalytics
* Patch: fix tests
* Use non-authenticating URL for Vcs-Git.
* Add "status" action to init script.

[Stig Sandbeck Mathisen]
* New upstream release (Closes: #621486) (LP: #682680)
* Remove build dependency on drizzle
  (until it reaches testing again)
* Build with support for tokyocabinet
* Remove backported ipv6 patch
* Patch: disable hostile build tests, they take hours...
* Patch: workaround duplicate address issue for tests
* Do not build API documentation, the sources are not shipped in
  upstream tarball
* Update debian/copyright

Show diffs side-by-side

added added

removed removed

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