← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_client_add_task_low_background.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_client_add_task_low_background.3
1
 
.TH "GEARMAN_CLIENT_ADD_TASK_LOW_BACKGROUND" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_client_add_task_low_background \- 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_task_st *gearman_client_add_task_background(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
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B gearman_task_st *gearman_client_add_task_high_background(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_background(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
48
 
.sp
49
 
Link with \-lgearman
50
 
.SH DESCRIPTION
51
 
.sp
52
 
\fI\%gearman_client_add_task_background()\fP creates a background task and adds it ito the given \fBgearman_client_st\fP. Execution of the task does now begin until \fBgearman_client_run_tasks()\fP is called.
53
 
.sp
54
 
If the unique value is not set, then a unique will be assigned.
55
 
.sp
56
 
\fI\%gearman_client_add_task_high_background()\fP and \fI\%gearman_client_add_task_low_background()\fP are
57
 
identical to \fBgearman_client_do()\fP, only they set the priority to
58
 
either high or low.
59
 
.IP Warning
60
 
You may wish to avoid using \fI\%gearman_client_add_task_background()\fP with a stack based allocated
61
 
\fBgearman_task_st\fP. The most common issues related to ABI safety involve stack allocated structures. If you use a stack based
62
 
\fBgearman_task_st\fP you must free it with \fBgearman_task_free()\fP.
63
 
.RE
64
 
.SH RETURN VALUE
65
 
.sp
66
 
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.
67
 
.SH HOME
68
 
.sp
69
 
To find out more information please check:
70
 
\fI\%http://gearman.info/\fP
71
 
.IP "See also"
72
 
.RE
73
 
.sp
74
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_task_st\fP
75
 
.SH AUTHOR
76
 
Data Differential http://www.datadifferential.com/
77
 
.SH COPYRIGHT
78
 
2012, Data Differential, http://www.datadifferential.com/
79
 
.\" Generated by docutils manpage writer.
80
 
.\" 
81
 
.