~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/memcached_result_cas.3

  • Committer: Continuous Integration
  • Date: 2012-03-14 16:53:36 UTC
  • mfrom: (990.2.1 workspace)
  • Revision ID: ci@tangent.org-20120314165336-mjrg2hwmb6sx1er2
jenkins-promote-staging-trunk-libmemcached-3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "MEMCACHED_RESULT_CAS" "3" "January 26, 2012" "1.0.4" "libmemcached"
 
1
.TH "MEMCACHED_RESULT_CAS" "3" "March 14, 2012" "1.0.5" "libmemcached"
2
2
.SH NAME
3
3
memcached_result_cas \- Working with result sets
4
4
.
39
39
.UNINDENT
40
40
.INDENT 0.0
41
41
.TP
42
 
.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B void memcached_result_free (memcached_result_st *result);
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B const char * memcached_result_key_value (memcached_result_st *result);
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B size_t memcached_result_key_length (const memcached_result_st *result);
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B const char *memcached_result_value (memcached_result_st *ptr);
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B size_t memcached_result_length (const memcached_result_st *ptr);
 
42
.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
 
59
.UNINDENT
 
60
.INDENT 0.0
 
61
.TP
 
62
.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
63
63
.UNINDENT
64
64
.INDENT 0.0
65
65
.TP
67
67
.UNINDENT
68
68
.INDENT 0.0
69
69
.TP
70
 
.B uint64_t memcached_result_cas (const memcached_result_st *result);
 
70
.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
71
71
.UNINDENT
72
72
.INDENT 0.0
73
73
.TP
96
96
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
97
97
not write code to directly access members of the structure.
98
98
.sp
99
 
\fBmemcached_result_create()\fP will either allocate memory for a
 
99
\fI\%memcached_result_create()\fP will either allocate memory for a
100
100
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
101
101
.sp
102
 
\fBmemcached_result_free()\fP will deallocate any memory attached to the
 
102
\fI\%memcached_result_free()\fP will deallocate any memory attached to the
103
103
structure. If the structure was also allocated, it will deallocate it.
104
104
.sp
105
 
\fBmemcached_result_key_value()\fP returns the key value associated with the
 
105
\fI\%memcached_result_key_value()\fP returns the key value associated with the
106
106
current result object.
107
107
.sp
108
 
\fBmemcached_result_key_length()\fP returns the key length associated with
 
108
\fI\%memcached_result_key_length()\fP returns the key length associated with
109
109
the current result object.
110
110
.sp
111
 
\fBmemcached_result_value()\fP returns the result value associated with the
 
111
\fI\%memcached_result_value()\fP returns the result value associated with the
112
112
current result object.
113
113
.sp
114
 
\fBmemcached_result_length()\fP returns the result length associated with
 
114
\fI\%memcached_result_length()\fP returns the result length associated with
115
115
the current result object.
116
116
.sp
117
117
\fI\%memcached_result_flags()\fP returns the flags associated with the
118
118
current result object.
119
119
.sp
120
 
\fBmemcached_result_cas()\fP returns the cas associated with the
 
120
\fI\%memcached_result_cas()\fP returns the cas associated with the
121
121
current result object. This value will only be available if the server
122
122
tests it.
123
123
.sp
124
124
\fI\%memcached_result_set_value()\fP takes a byte array and a size and sets
125
125
the result to this value. This function is used for trigger responses.
126
126
.sp
127
 
\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
128
 
a new value for the flags field.
 
127
\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
 
128
value for the flags field.
129
129
.sp
130
 
\fBvoid memcached_result_set_expiration(A)()\fP takes a result structure and stores a new value for the expiration field (this is only used by read
131
 
through triggers).
 
130
\fI\%memcached_result_set_expiration()\fP takes a result structure and stores
 
131
a new value for the expiration field (this is only used by read through
 
132
triggers).
132
133
.sp
133
134
You may wish to avoid using memcached_result_create(3) with a
134
135
stack based allocation. The most common issues related to ABI safety involve
136
137
.SH RETURN
137
138
.sp
138
139
Varies, see particular functions. All structures must have
139
 
\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
 
140
\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
140
141
to do this will result in leaked memory.
141
142
.SH HOME
142
143
.sp