Update docs.
[m6w6/libmemcached] / docs / man / memcached_return_t.3
1 .TH "MEMCACHED_RETURN_T" "3" "January 26, 2012" "1.0.4" "libmemcached"
2 .SH NAME
3 memcached_return_t \- Return type values
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 <libmemcached/memcached.h>
36 .INDENT 0.0
37 .TP
38 .B memcached_return_t
39 .UNINDENT
40 .INDENT 0.0
41 .TP
42 .B const char *libmemcached_strerror(libmemcached_return_t\fI\ rc\fP)
43 .UNINDENT
44 .INDENT 0.0
45 .TP
46 .B bool libmemcached_success(libmemcached_return_t\fI\ rc\fP)
47 .UNINDENT
48 .INDENT 0.0
49 .TP
50 .B bool libmemcached_failure(libmemcached_return_t\fI\ rc\fP)
51 .UNINDENT
52 .INDENT 0.0
53 .TP
54 .B bool libmemcache_continue(libmemcached_return_t\fI\ rc\fP)
55 .UNINDENT
56 .sp
57 \fBmemcached_success()\fP return true if \fI\%MEMCACHED_SUCCESS\fP tested true.
58 .sp
59 \fBmemcached_failure()\fP return true if any value other then \fI\%MEMCACHED_SUCCESS\fP was provided.
60 .SS Libmemcached return types:
61 .INDENT 0.0
62 .TP
63 .B MEMCACHED_SUCCESS
64 .UNINDENT
65 .sp
66 Success
67 .INDENT 0.0
68 .TP
69 .B MEMCACHED_FAILURE
70 .UNINDENT
71 .INDENT 0.0
72 .TP
73 .B MEMCACHED_HOST_LOOKUP_FAILURE
74 .UNINDENT
75 .INDENT 0.0
76 .TP
77 .B MEMCACHED_CONNECTION_FAILURE
78 .UNINDENT
79 .INDENT 0.0
80 .TP
81 .B MEMCACHED_CONNECTION_BIND_FAILURE
82 .UNINDENT
83 .sp
84 Deprecated since version <0.30.
85 .INDENT 0.0
86 .TP
87 .B MEMCACHED_WRITE_FAILURE
88 .UNINDENT
89 .INDENT 0.0
90 .TP
91 .B MEMCACHED_READ_FAILURE
92 .UNINDENT
93 .INDENT 0.0
94 .TP
95 .B MEMCACHED_UNKNOWN_READ_FAILURE
96 .UNINDENT
97 .INDENT 0.0
98 .TP
99 .B MEMCACHED_PROTOCOL_ERROR
100 .UNINDENT
101 .INDENT 0.0
102 .TP
103 .B MEMCACHED_CLIENT_ERROR
104 .UNINDENT
105 .INDENT 0.0
106 .TP
107 .B MEMCACHED_SERVER_ERROR
108 .UNINDENT
109 .INDENT 0.0
110 .TP
111 .B MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
112 .UNINDENT
113 .sp
114 Deprecated since version <0.30.
115 .INDENT 0.0
116 .TP
117 .B MEMCACHED_DATA_EXISTS
118 .UNINDENT
119 .INDENT 0.0
120 .TP
121 .B MEMCACHED_DATA_DOES_NOT_EXIST
122 .UNINDENT
123 .INDENT 0.0
124 .TP
125 .B MEMCACHED_NOTSTORED
126 .UNINDENT
127 .INDENT 0.0
128 .TP
129 .B MEMCACHED_STORED
130 .UNINDENT
131 .INDENT 0.0
132 .TP
133 .B MEMCACHED_NOTFOUND
134 .UNINDENT
135 .INDENT 0.0
136 .TP
137 .B MEMCACHED_MEMORY_ALLOCATION_FAILURE
138 .UNINDENT
139 .INDENT 0.0
140 .TP
141 .B MEMCACHED_PARTIAL_READ
142 .UNINDENT
143 .INDENT 0.0
144 .TP
145 .B MEMCACHED_SOME_ERRORS
146 .UNINDENT
147 .INDENT 0.0
148 .TP
149 .B MEMCACHED_NO_SERVERS
150 .UNINDENT
151 .INDENT 0.0
152 .TP
153 .B MEMCACHED_END
154 .UNINDENT
155 .INDENT 0.0
156 .TP
157 .B MEMCACHED_DELETED
158 .UNINDENT
159 .INDENT 0.0
160 .TP
161 .B MEMCACHED_VALUE
162 .UNINDENT
163 .INDENT 0.0
164 .TP
165 .B MEMCACHED_STAT
166 .UNINDENT
167 .INDENT 0.0
168 .TP
169 .B MEMCACHED_ITEM
170 .UNINDENT
171 .INDENT 0.0
172 .TP
173 .B MEMCACHED_ERRNO
174 .UNINDENT
175 .INDENT 0.0
176 .TP
177 .B MEMCACHED_FAIL_UNIX_SOCKET
178 .UNINDENT
179 .sp
180 Deprecated since version <0.30.
181 .INDENT 0.0
182 .TP
183 .B MEMCACHED_NOT_SUPPORTED
184 .UNINDENT
185 .INDENT 0.0
186 .TP
187 .B MEMCACHED_NO_KEY_PROVIDED
188 .UNINDENT
189 .sp
190 Deprecated since version <0.30: Use \fI\%MEMCACHED_BAD_KEY_PROVIDED\fP instead.
191 .INDENT 0.0
192 .TP
193 .B MEMCACHED_FETCH_NOTFINISHED
194 .UNINDENT
195 .INDENT 0.0
196 .TP
197 .B MEMCACHED_TIMEOUT
198 Connection to server timed out.
199 .UNINDENT
200 .INDENT 0.0
201 .TP
202 .B MEMCACHED_BUFFERED
203 .UNINDENT
204 .INDENT 0.0
205 .TP
206 .B MEMCACHED_BAD_KEY_PROVIDED
207 .UNINDENT
208 .INDENT 0.0
209 .TP
210 .B MEMCACHED_INVALID_HOST_PROTOCOL
211 .UNINDENT
212 .INDENT 0.0
213 .TP
214 .B MEMCACHED_SERVER_MARKED_DEAD
215 .UNINDENT
216 .INDENT 0.0
217 .TP
218 .B MEMCACHED_UNKNOWN_STAT_KEY
219 .UNINDENT
220 .INDENT 0.0
221 .TP
222 .B MEMCACHED_E2BIG
223 .UNINDENT
224 .INDENT 0.0
225 .TP
226 .B MEMCACHED_INVALID_ARGUMENTS
227 .UNINDENT
228 .INDENT 0.0
229 .TP
230 .B MEMCACHED_KEY_TOO_BIG
231 .UNINDENT
232 .INDENT 0.0
233 .TP
234 .B MEMCACHED_AUTH_PROBLEM
235 .UNINDENT
236 .INDENT 0.0
237 .TP
238 .B MEMCACHED_AUTH_FAILURE
239 .UNINDENT
240 .INDENT 0.0
241 .TP
242 .B MEMCACHED_AUTH_CONTINUE
243 .UNINDENT
244 .INDENT 0.0
245 .TP
246 .B MEMCACHED_PARSE_ERROR
247 .UNINDENT
248 .INDENT 0.0
249 .TP
250 .B MEMCACHED_PARSE_USER_ERROR
251 .UNINDENT
252 .INDENT 0.0
253 .TP
254 .B MEMCACHED_DEPRECATED
255 .UNINDENT
256 .SH SEE ALSO
257 .sp
258 \fImemcached(8)\fP \fIlibmemcached(3)\fP \fImemcached_client_error()\fP or \fImemcached_worker_error()\fP
259 .SH AUTHOR
260 Brian Aker
261 .SH COPYRIGHT
262 2011, Brian Aker DataDifferential, http://datadifferential.com/
263 .\" Generated by docutils manpage writer.
264 .\"
265 .