Final bits for 1.0.9
[m6w6/libmemcached] / docs / man / memcached_return_t.3
1 .TH "MEMCACHED_RETURN_T" "3" "July 05, 2012" "1.0.9" "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(\fI\%memcached_return_t\fP\fI\ rc\fP)
43 .UNINDENT
44 .INDENT 0.0
45 .TP
46 .B bool libmemcached_success(\fI\%memcached_return_t\fP\fI\ rc\fP)
47 .UNINDENT
48 .INDENT 0.0
49 .TP
50 .B bool libmemcached_failure(\fI\%memcached_return_t\fP\fI\ rc\fP)
51 .UNINDENT
52 .INDENT 0.0
53 .TP
54 .B bool libmemcache_continue(\fI\%memcached_return_t\fP\fI\ rc\fP)
55 .UNINDENT
56 .INDENT 0.0
57 .TP
58 .B bool memcached_success(\fI\%memcached_return_t\fP)
59 .UNINDENT
60 .INDENT 0.0
61 .TP
62 .B bool memcached_failure(\fI\%memcached_return_t\fP)
63 .UNINDENT
64 .sp
65 \fI\%memcached_success()\fP return true if \fBMEMCACHED_SUCCESS\fP tested true.
66 .sp
67 \fI\%memcached_failure()\fP return true if any value other then \fBMEMCACHED_SUCCESS\fP was provided.
68 .SS Libmemcached return types:
69 .sp
70 \fBMEMCACHED_SUCCESS\fP
71 .sp
72 \fBMEMCACHED_FAILURE\fP
73 .sp
74 \fBMEMCACHED_HOST_LOOKUP_FAILURE\fP
75 .sp
76 \fBMEMCACHED_CONNECTION_FAILURE\fP
77 .sp
78 \fBMEMCACHED_CONNECTION_BIND_FAILURE\fP
79 .sp
80 \fBMEMCACHED_WRITE_FAILURE\fP
81 .sp
82 \fBMEMCACHED_READ_FAILURE\fP
83 .sp
84 \fBMEMCACHED_UNKNOWN_READ_FAILURE\fP
85 .sp
86 \fBMEMCACHED_PROTOCOL_ERROR\fP
87 .sp
88 \fBMEMCACHED_CLIENT_ERROR\fP
89 .sp
90 \fBMEMCACHED_SERVER_ERROR\fP
91 .sp
92 \fBMEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE\fP
93 .sp
94 \fBMEMCACHED_DATA_EXISTS\fP
95 .sp
96 \fBMEMCACHED_DATA_DOES_NOT_EXIST\fP
97 .sp
98 \fBMEMCACHED_NOTSTORED\fP
99 .sp
100 \fBMEMCACHED_STORED\fP
101 .sp
102 \fBMEMCACHED_NOTFOUND\fP
103 .sp
104 \fBMEMCACHED_MEMORY_ALLOCATION_FAILURE\fP
105 .sp
106 \fBMEMCACHED_PARTIAL_READ\fP
107 .sp
108 \fBMEMCACHED_SOME_ERRORS\fP
109 .sp
110 \fBMEMCACHED_NO_SERVERS\fP
111 .sp
112 \fBMEMCACHED_END\fP
113 .sp
114 \fBMEMCACHED_DELETED\fP
115 .sp
116 \fBMEMCACHED_VALUE\fP
117 .sp
118 \fBMEMCACHED_STAT\fP
119 .sp
120 \fBMEMCACHED_ITEM\fP
121 .sp
122 \fBMEMCACHED_ERRNO\fP
123 .sp
124 \fBMEMCACHED_FAIL_UNIX_SOCKET\fP
125 .sp
126 \fBMEMCACHED_NOT_SUPPORTED\fP
127 .sp
128 \fBMEMCACHED_NO_KEY_PROVIDED\fP
129 .sp
130 \fBMEMCACHED_FETCH_NOTFINISHED\fP
131 .sp
132 \fBMEMCACHED_TIMEOUT\fP
133 .sp
134 \fBMEMCACHED_BUFFERED\fP
135 .sp
136 \fBMEMCACHED_BAD_KEY_PROVIDED\fP
137 .sp
138 \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP
139 .sp
140 \fBMEMCACHED_SERVER_MARKED_DEAD\fP
141 .sp
142 \fBMEMCACHED_UNKNOWN_STAT_KEY\fP
143 .sp
144 \fBMEMCACHED_E2BIG\fP
145 .sp
146 \fBMEMCACHED_INVALID_ARGUMENTS\fP
147 .sp
148 \fBMEMCACHED_KEY_TOO_BIG\fP
149 .sp
150 \fBMEMCACHED_AUTH_PROBLEM\fP
151 .sp
152 \fBMEMCACHED_AUTH_FAILURE\fP
153 .sp
154 \fBMEMCACHED_AUTH_CONTINUE\fP
155 .sp
156 \fBMEMCACHED_PARSE_ERROR\fP
157 .sp
158 \fBMEMCACHED_PARSE_USER_ERROR\fP
159 .sp
160 \fBMEMCACHED_DEPRECATED\fP
161 .SH SEE ALSO
162 .sp
163 \fImemcached\fP \fIlibmemcached\fP \fImemcached_client_error\fP or \fImemcached_worker_error\fP
164 .SH AUTHOR
165 Brian Aker
166 .SH COPYRIGHT
167 2011, Brian Aker DataDifferential, http://datadifferential.com/
168 .\" Generated by docutils manpage writer.
169 .\"
170 .