← Back to branch summary

~mordred/gearmand/cancel-job

« back to all changes in this revision

Viewing changes to docs/man/gearman_job_function_name.3

  • Committer: Brian Aker
  • Date: 2012-05-04 03:46:04 UTC
  • Revision ID: brian@tangent.org-20120504034604-5t22ae4v2o45zjkq
Update for libtest, documentation, and fix for root bzr dir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/gearman_job_function_name.3
1
 
.TH "GEARMAN_JOB_FUNCTION_NAME" "3" "April 17, 2012" "0.32" "Gearmand"
 
1
.TH "GEARMAN_JOB_FUNCTION_NAME" "3" "May 03, 2012" "0.33" "Gearmand"
2
2
.SH NAME
3
3
gearman_job_function_name \- Gearmand Documentation, http://gearman.info/
4
4
.
39
39
.UNINDENT
40
40
.INDENT 0.0
41
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);
 
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
91
.UNINDENT
92
92
.sp
93
93
Link with \-lgearman
94
94
.SH DESCRIPTION
95
95
.sp
96
 
\fBgeaman_job_st\fP are passed to worker functions to represent jobs that are being run by \fBgearman_worker_work()\fP.
 
96
\fI\%gearman_job_st\fP are passed to worker functions to represent jobs that are being run by \fBgearman_worker_work()\fP.
97
97
.sp
98
 
\fBgearman_job_free()\fP is used to free a job. This only needs to be
 
98
\fI\%gearman_job_free()\fP is used to free a job. This only needs to be
99
99
done if a task was created with a preallocated structure.
100
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
 
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
114
110
\fIfree(3)\fP by the caller.
115
111
.SH RETURN VALUE
116
112
.sp