← Back to branch summary

~mordred/gearmand/cancel-job

« back to all changes in this revision

Viewing changes to docs/man/gearman_result_integer.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_result_integer.3
1
 
.TH "GEARMAN_RESULT_INTEGER" "3" "April 17, 2012" "0.32" "Gearmand"
 
1
.TH "GEARMAN_RESULT_INTEGER" "3" "May 03, 2012" "0.33" "Gearmand"
2
2
.SH NAME
3
3
gearman_result_integer \- Gearmand Documentation, http://gearman.info/
4
4
.
35
35
#include <libgearman/gearman.h>
36
36
.INDENT 0.0
37
37
.TP
38
 
.B gearman_result_t
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B int64_t gearman_result_integer(const gearman_result_st\fI\ *self\fP)
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B bool gearman_result_boolean(const gearman_result_st\fI\ *self\fP)
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B gearman_string_t gearman_result_string(const gearman_result_st\fI\ *self\fP)
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B gearman_return_t gearman_result_store_string(gearman_result_st\fI\ *self\fP, gearman_string_t\fI\ arg\fP)
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B void gearman_result_store_integer(gearman_result_st\fI\ *self\fP, int64_t\fI\ value\fP)
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B gearman_return_t gearman_result_store_value(gearman_result_st\fI\ *self\fP, const void\fI\ *value\fP, size_t\fI\ size\fP)
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B size_t gearman_result_size(const gearman_result_st\fI\ *self\fP)
67
 
.UNINDENT
68
 
.INDENT 0.0
69
 
.TP
70
 
.B const char *gearman_result_value(const gearman_result_st\fI\ *self\fP)
71
 
.UNINDENT
72
 
.INDENT 0.0
73
 
.TP
74
 
.B bool gearman_result_is_null(const gearman_result_st\fI\ *self\fP)
 
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)
75
79
.UNINDENT
76
80
.sp
77
81
Compile and link with \-lgearman
78
82
.SH DESCRIPTION
79
83
.sp
80
 
The \fBgearman_result_t()\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.
81
 
.sp
82
 
\fBgearman_task_result()\fP returns \fBgearman_result_t()\fP from a \fBgearman_task_st\fP.
83
 
.sp
84
 
A \fBgearman_result_t()\fP can return the resulting value as either a char pointer, boolean, \fBgearman_string_t\fP, or int64_t.
 
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.
85
89
.SH SEE ALSO
86
90
.sp
87
91
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_error()\fP or \fIgearman_worker_error()\fP