← 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_client_do_job_handle.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_client_do_job_handle.3
 
1
.TH "GEARMAN_CLIENT_DO_JOB_HANDLE" "3" "December 15, 2011" "0.26" "Gearmand"
 
2
.SH NAME
 
3
gearman_client_do_job_handle \- 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_client_st
 
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B int gearman_client_timeout(\fI\%gearman_client_st\fP\fI\ *client\fP)
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B void gearman_client_set_timeout(\fI\%gearman_client_st\fP\fI\ *client\fP, int\fI\ timeout\fP)
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B void *gearman_client_context(const \fI\%gearman_client_st\fP\fI\ *client\fP)
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B void gearman_client_set_context(\fI\%gearman_client_st\fP\fI\ *client\fP, void\fI\ *context\fP)
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.B void gearman_client_set_workload_malloc_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, gearman_malloc_fn\fI\ *function\fP, void\fI\ *context\fP)
 
59
.UNINDENT
 
60
.sp
 
61
Deprecated since version 0.23: Use \fBgearman_allocator_t\fP
 
62
.INDENT 0.0
 
63
.TP
 
64
.B void gearman_client_set_workload_free_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, gearman_free_fn\fI\ *function\fP, void\fI\ *context\fP)
 
65
.UNINDENT
 
66
.sp
 
67
Deprecated since version 0.23: Use \fBgearman_allocator_t\fP
 
68
.INDENT 0.0
 
69
.TP
 
70
.B void gearman_client_task_free_all(\fI\%gearman_client_st\fP\fI\ *client\fP)
 
71
.UNINDENT
 
72
.INDENT 0.0
 
73
.TP
 
74
.B void gearman_client_set_task_context_free_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, gearman_task_context_free_fn\fI\ *function\fP)
 
75
.UNINDENT
 
76
.sp
 
77
Link with \-lgearman
 
78
.SH DESCRIPTION
 
79
.sp
 
80
\fI\%gearman_client_st\fP is used for \fIclient\fP communication with the server.
 
81
.sp
 
82
\fI\%gearman_client_context()\fP and \fI\%gearman_client_set_context()\fP can be used to store an arbitrary object for the user.
 
83
.sp
 
84
\fI\%gearman_client_set_task_context_free_fn()\fP sets a trigger that will be called when a \fBgearman_task_st\fP is released.
 
85
.sp
 
86
\fI\%gearman_client_timeout()\fP and \fI\%gearman_client_set_timeout()\fP get and set the current timeout value, in milliseconds, for the client.
 
87
.sp
 
88
Normally \fImalloc(3)\fP and \fIfree(3)\fP are used for allocation and releasing workloads. \fI\%gearman_client_set_workload_malloc_fn()\fP and \fI\%gearman_client_set_workload_free_fn()\fP can be used to replace these with custom functions. (These have been deprecated, please see \fBgearman_allocator_t\fP for the updated interface.
 
89
.sp
 
90
\fI\%gearman_client_task_free_all()\fP is used to free all current \fBgearman_task_st\fP that have been created with the \fI\%gearman_client_st\fP.
 
91
.IP Warning
 
92
By calling \fI\%gearman_client_task_free_all()\fP you can end up with a SEGFAULT if you try to use any \fBgearman_task_st\fP that you have kept pointers too.
 
93
.RE
 
94
.SH RETURN VALUE
 
95
.sp
 
96
\fI\%gearman_client_timeout()\fP returns an integer representing the amount of time in milliseconds. A value of \-1 means an infinite timeout value. See \fIpoll(3)\fP for more details.
 
97
.SH HOME
 
98
.sp
 
99
To find out more information please check:
 
100
\fI\%http://gearman.info/\fP
 
101
.IP "See also"
 
102
.sp
 
103
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_create(3)\fP
 
104
.RE
 
105
.SH AUTHOR
 
106
Data Differential http://datadifferential.com/
 
107
.SH COPYRIGHT
 
108
2011, Data Differential, http://datadifferential.com/
 
109
.\" Generated by docutils manpage writer.
 
110
.\" 
 
111
.