← Back to branch summary

~fractalcat/gearmand/docfixes

« back to all changes in this revision

Viewing changes to docs/man/gearman_result_store_integer.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_result_store_integer.3
1
 
.TH "GEARMAN_RESULT_STORE_INTEGER" "3" "September 14, 2012" "0.38" "Gearmand"
2
 
.SH NAME
3
 
gearman_result_store_integer \- 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_result_st
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B \fI\%gearman_result_st\fP *gearman_task_result(gearman_task_st\fI\ *task\fP)
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B int64_t gearman_result_integer(const \fI\%gearman_result_st\fP\fI\ *self\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B bool gearman_result_boolean(const \fI\%gearman_result_st\fP\fI\ *self\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B gearman_string_t gearman_result_string(const \fI\%gearman_result_st\fP\fI\ *self\fP)
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B gearman_return_t gearman_result_store_string(\fI\%gearman_result_st\fP\fI\ *self\fP, gearman_string_t\fI\ arg\fP)
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B void gearman_result_store_integer(\fI\%gearman_result_st\fP\fI\ *self\fP, int64_t\fI\ value\fP)
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B gearman_return_t gearman_result_store_value(\fI\%gearman_result_st\fP\fI\ *self\fP, const void\fI\ *value\fP, size_t\fI\ size\fP)
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B size_t gearman_result_size(const \fI\%gearman_result_st\fP\fI\ *self\fP)
71
 
.UNINDENT
72
 
.INDENT 0.0
73
 
.TP
74
 
.B const char *gearman_result_value(const \fI\%gearman_result_st\fP\fI\ *self\fP)
75
 
.UNINDENT
76
 
.INDENT 0.0
77
 
.TP
78
 
.B bool gearman_result_is_null(const \fI\%gearman_result_st\fP\fI\ *self\fP)
79
 
.UNINDENT
80
 
.sp
81
 
Compile and link with \-lgearman
82
 
.SH DESCRIPTION
83
 
.sp
84
 
The \fI\%gearman_result_st\fP type represents a result set. \fBgearman_aggregator_fn\fP is passed on these types which it uses to create a final result that is returned to the client.
85
 
.sp
86
 
\fI\%gearman_task_result()\fP returns \fI\%gearman_result_st\fP from a \fBgearman_task_st\fP.
87
 
.sp
88
 
A \fI\%gearman_result_st\fP can return the resulting value as either a char pointer, boolean, \fBgearman_string_t\fP, or int64_t.
89
 
.SH SEE ALSO
90
 
.sp
91
 
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_error()\fP or \fIgearman_worker_error()\fP
92
 
.SH AUTHOR
93
 
Data Differential http://www.datadifferential.com/
94
 
.SH COPYRIGHT
95
 
2012, Data Differential, http://www.datadifferential.com/
96
 
.\" Generated by docutils manpage writer.
97
 
.\" 
98
 
.