← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_job_send_data.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_job_send_data.3
1
 
.TH "GEARMAN_JOB_SEND_DATA" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_job_send_data \- 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(\fI\%gearman_job_st\fP\fI\ *job\fP)
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B gearman_return_t gearman_job_send_data(\fI\%gearman_job_st\fP\fI\ *job\fP, const void\fI\ *data\fP, size_t\fI\ data_size\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B gearman_return_t gearman_job_send_warning(\fI\%gearman_job_st\fP\fI\ *job\fP, const void\fI\ *warning\fP, size_t\fI\ warning_size\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B gearman_return_t gearman_job_send_status(\fI\%gearman_job_st\fP\fI\ *job\fP, uint32_t\fI\ numerator\fP, uint32_t\fI\ denominator\fP)
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B gearman_return_t gearman_job_send_complete(\fI\%gearman_job_st\fP\fI\ *job\fP, const void\fI\ *result\fP, size_t\fI\ result_size\fP)
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B gearman_return_t gearman_job_send_exception(\fI\%gearman_job_st\fP\fI\ *job\fP, const void\fI\ *exception\fP, size_t\fI\ exception_size\fP)
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B gearman_return_t gearman_job_send_fail(\fI\%gearman_job_st\fP\fI\ *job\fP)
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B const char *gearman_job_handle(const \fI\%gearman_job_st\fP\fI\ *job\fP)
71
 
.UNINDENT
72
 
.INDENT 0.0
73
 
.TP
74
 
.B const char *gearman_job_function_name(const \fI\%gearman_job_st\fP\fI\ *job\fP)
75
 
.UNINDENT
76
 
.INDENT 0.0
77
 
.TP
78
 
.B const char *gearman_job_unique(const \fI\%gearman_job_st\fP\fI\ *job\fP)
79
 
.UNINDENT
80
 
.INDENT 0.0
81
 
.TP
82
 
.B const void *gearman_job_workload(const \fI\%gearman_job_st\fP\fI\ *job\fP)
83
 
.UNINDENT
84
 
.INDENT 0.0
85
 
.TP
86
 
.B size_t gearman_job_workload_size(const \fI\%gearman_job_st\fP\fI\ *job\fP)
87
 
.UNINDENT
88
 
.INDENT 0.0
89
 
.TP
90
 
.B void *gearman_job_take_workload(\fI\%gearman_job_st\fP\fI\ *job\fP, size_t\fI\ *data_size\fP)
91
 
.UNINDENT
92
 
.sp
93
 
Link with \-lgearman
94
 
.SH DESCRIPTION
95
 
.sp
96
 
\fI\%gearman_job_st\fP are passed to worker functions to represent jobs that are being run by \fBgearman_worker_work()\fP.
97
 
.sp
98
 
\fI\%gearman_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
 
\fI\%gearman_job_handle()\fP returns the job handle(see \fBgearman_job_handle_t\fP for more information).
102
 
.sp
103
 
\fI\%gearman_job_function_name()\fP return the name of the function that the
104
 
job was set to execute against.
105
 
.sp
106
 
\fI\%gearman_job_unique()\fP return the unique value that was used for \fI\%gearman_job_st\fP.
107
 
.sp
108
 
returns the \fI\%gearman_job_st\fP workload. The size of it can be determined with \fI\%gearman_job_workload_size()\fP.
109
 
\fI\%gearman_job_take_workload()\fP is the same as \fI\%gearman_job_workload()\fP with the exception that the result must be
110
 
\fIfree(3)\fP by the caller.
111
 
.SH RETURN VALUE
112
 
.sp
113
 
A value of \fBgearman_return_t\fP  is returned.  On success that value
114
 
will be :c:type::\fIGEARMAN_SUCCESS\fP.  Use \fBgearman_strerror()\fP to
115
 
translate this value to a printable string.
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://www.datadifferential.com/
125
 
.SH COPYRIGHT
126
 
2012, Data Differential, http://www.datadifferential.com/
127
 
.\" Generated by docutils manpage writer.
128
 
.\" 
129
 
.