← 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_job_send_exception.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_job_send_exception.3
 
1
.TH "GEARMAN_JOB_SEND_EXCEPTION" "3" "December 15, 2011" "0.26" "Gearmand"
 
2
.SH NAME
 
3
gearman_job_send_exception \- 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_job_st
 
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B void gearman_job_free(gearman_job_st *job);
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B gearman_return_t gearman_job_send_data(gearman_job_st *job, const void *data, size_t data_size);
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B gearman_return_t gearman_job_send_warning(gearman_job_st *job, const void *warning, size_t warning_size);
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B gearman_return_t gearman_job_send_status(gearman_job_st *job, uint32_t numerator, uint32_t denominator);
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.B gearman_return_t gearman_job_send_complete(gearman_job_st *job, const void *result, size_t result_size);
 
59
.UNINDENT
 
60
.INDENT 0.0
 
61
.TP
 
62
.B gearman_return_t gearman_job_send_exception(gearman_job_st *job, const void *exception, size_t exception_size);
 
63
.UNINDENT
 
64
.INDENT 0.0
 
65
.TP
 
66
.B gearman_return_t gearman_job_send_fail(gearman_job_st *job);
 
67
.UNINDENT
 
68
.INDENT 0.0
 
69
.TP
 
70
.B const char *gearman_job_handle(const gearman_job_st *job);
 
71
.UNINDENT
 
72
.INDENT 0.0
 
73
.TP
 
74
.B const char *gearman_job_function_name(const gearman_job_st *job);
 
75
.UNINDENT
 
76
.INDENT 0.0
 
77
.TP
 
78
.B const char *gearman_job_unique(const gearman_job_st *job);
 
79
.UNINDENT
 
80
.INDENT 0.0
 
81
.TP
 
82
.B const void *gearman_job_workload(const gearman_job_st *job);
 
83
.UNINDENT
 
84
.INDENT 0.0
 
85
.TP
 
86
.B size_t gearman_job_workload_size(const gearman_job_st *job);
 
87
.UNINDENT
 
88
.INDENT 0.0
 
89
.TP
 
90
.B void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size);
 
91
.UNINDENT
 
92
.sp
 
93
Link with \-lgearman
 
94
.SH DESCRIPTION
 
95
.sp
 
96
\fBgeaman_job_st\fP are passed to worker functions to represent jobs that are being run by \fBgearman_worker_work()\fP.
 
97
.sp
 
98
\fBgearman_job_free()\fP is used to free a job. This only needs to be
 
99
done if a task was created with a preallocated structure.
 
100
.sp
 
101
\fBgearman_job_handle()\fP returns the job handle(see
 
102
\fBgearman_job_t\fP for more information).
 
103
.sp
 
104
\fBgearman_job_function_name()\fP return the name of the function that
 
105
the job was set to execute against.
 
106
.sp
 
107
\fBgearman_job_unique()\fP return the unique value that was used for
 
108
\fI\%gearman_job_st\fP.
 
109
.sp
 
110
returns the \fI\%gearman_job_st\fP workload. The size of it can be
 
111
determined with \fBgearman_job_workload_size()\fP.
 
112
\fBgearman_job_take_workload()\fP is the same as
 
113
\fBgearman_job_workload()\fP with the exception that the result must be
 
114
\fIfree(3)\fP by the caller.
 
115
.SH RETURN VALUE
 
116
.sp
 
117
A value of \fBgearman_return_t\fP  is returned.  On success that value
 
118
will be :c:type::\fIGEARMAN_SUCCESS\fP.  Use \fBgearman_strerror()\fP to
 
119
translate this value to a printable string.
 
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://datadifferential.com/
 
129
.SH COPYRIGHT
 
130
2011, Data Differential, http://datadifferential.com/
 
131
.\" Generated by docutils manpage writer.
 
132
.\" 
 
133
.