← Back to branch summary

~mordred/gearmand/cancel-job

« back to all changes in this revision

Viewing changes to docs/man/gearman_client_add_task.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_client_add_task.3
1
 
.TH "GEARMAN_CLIENT_ADD_TASK" "3" "April 17, 2012" "0.32" "Gearmand"
 
1
.TH "GEARMAN_CLIENT_ADD_TASK" "3" "May 03, 2012" "0.33" "Gearmand"
2
2
.SH NAME
3
3
gearman_client_add_task \- Gearmand Documentation, http://gearman.info/
4
4
.
37
37
.TP
38
38
.B gearman_task_st *gearman_client_add_task(gearman_client_st\fI\ *client\fP, gearman_task_st\fI\ *task\fP, void\fI\ *context\fP, const char\fI\ *function_name\fP, const char\fI\ *unique\fP, const void\fI\ *workload\fP, size_t\fI\ workload_size\fP, gearman_return_t\fI\ *ret_ptr\fP)
39
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B gearman_task_st *gearman_client_add_task_high(gearman_client_st\fI\ *client\fP, gearman_task_st\fI\ *task\fP, void\fI\ *context\fP, const char\fI\ *function_name\fP, const char\fI\ *unique\fP, const void\fI\ *workload\fP, size_t\fI\ workload_size\fP, gearman_return_t\fI\ *ret_ptr\fP)
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B gearman_task_st *gearman_client_add_task_low(gearman_client_st\fI\ *client\fP, gearman_task_st\fI\ *task\fP, void\fI\ *context\fP, const char\fI\ *function_name\fP, const char\fI\ *unique\fP, const void\fI\ *workload\fP, size_t\fI\ workload_size\fP, gearman_return_t\fI\ *ret_ptr\fP)
 
47
.UNINDENT
40
48
.sp
41
49
Link with \-lgearman
42
50
.SH DESCRIPTION
45
53
.sp
46
54
If the unique value is not set, then a unique will be assigned.
47
55
.sp
48
 
\fBgearman_client_add_task_high()\fP and \fBgearman_client_add_task_low()\fP are
49
 
identical to \fBgearman_client_do()\fP, only they set the priority to
50
 
either high or low.
 
56
\fI\%gearman_client_add_task_high()\fP and \fI\%gearman_client_add_task_low()\fP are identical to \fBgearman_client_do()\fP, only they set the priority to either high or low.
51
57
.SH RETURN VALUE
52
58
.sp
53
59
The \fBgearman_task_st\fP is created and a pointer to it is returned. On error NULL is returned and ret_ptr is set with a \fBgearman_return_t\fP.