Merge in trunk. Updates to manual/update to latest libtest.
[awesomized/libmemcached] / docs / libmemcached / memcached_return_t.rst
1 ================================
2 Error Codes (memcached_return_t)
3 ================================
4
5 --------
6 SYNOPSIS
7 --------
8
9 #include <libmemcached/memcached.h>
10
11 .. c:type:: memcached_return_t
12
13 .. c:function:: const char *libmemcached_strerror(libmemcached_return_t rc)
14
15 .. c:function:: bool libmemcached_success(libmemcached_return_t rc)
16
17 .. c:function:: bool libmemcached_failure(libmemcached_return_t rc)
18
19 .. c:function:: bool libmemcache_continue(libmemcached_return_t rc)
20
21
22
23 :c:func:`memcached_success()` return true if :c:type:`MEMCACHED_SUCCESS` tested true.
24
25 :c:func:`memcached_failure()` return true if any value other then :c:type:`MEMCACHED_SUCCESS` was provided.
26
27
28 Libmemcached return types:
29 ++++++++++++++++++++++++++
30
31
32 .. c:type:: MEMCACHED_SUCCESS
33
34 Success
35
36 .. c:type:: MEMCACHED_FAILURE
37
38 .. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE
39
40 .. c:type:: MEMCACHED_CONNECTION_FAILURE
41
42 .. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE
43 .. deprecated:: <0.30
44
45 .. c:type:: MEMCACHED_WRITE_FAILURE
46
47 .. c:type:: MEMCACHED_READ_FAILURE
48
49 .. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE
50
51 .. c:type:: MEMCACHED_PROTOCOL_ERROR
52
53 .. c:type:: MEMCACHED_CLIENT_ERROR
54
55 .. c:type:: MEMCACHED_SERVER_ERROR
56
57 .. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
58 .. deprecated:: <0.30
59
60 .. c:type:: MEMCACHED_DATA_EXISTS
61
62 .. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST
63
64 .. c:type:: MEMCACHED_NOTSTORED
65
66 .. c:type:: MEMCACHED_STORED
67
68 .. c:type:: MEMCACHED_NOTFOUND
69
70 .. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
71
72 .. c:type:: MEMCACHED_PARTIAL_READ
73
74 .. c:type:: MEMCACHED_SOME_ERRORS
75
76 .. c:type:: MEMCACHED_NO_SERVERS
77
78 .. c:type:: MEMCACHED_END
79
80 .. c:type:: MEMCACHED_DELETED
81
82 .. c:type:: MEMCACHED_VALUE
83
84 .. c:type:: MEMCACHED_STAT
85
86 .. c:type:: MEMCACHED_ITEM
87
88 .. c:type:: MEMCACHED_ERRNO
89
90 .. c:type:: MEMCACHED_FAIL_UNIX_SOCKET
91 .. deprecated:: <0.30
92
93 .. c:type:: MEMCACHED_NOT_SUPPORTED
94
95 .. c:type:: MEMCACHED_NO_KEY_PROVIDED
96 .. deprecated:: <0.30
97 Use :c:type:`MEMCACHED_BAD_KEY_PROVIDED` instead.
98
99 .. c:type:: MEMCACHED_FETCH_NOTFINISHED
100
101 .. c:type:: MEMCACHED_TIMEOUT
102
103 Connection to server timed out.
104
105 .. c:type:: MEMCACHED_BUFFERED
106
107 .. c:type:: MEMCACHED_BAD_KEY_PROVIDED
108
109 .. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL
110
111 .. c:type:: MEMCACHED_SERVER_MARKED_DEAD
112
113 .. c:type:: MEMCACHED_UNKNOWN_STAT_KEY
114
115 .. c:type:: MEMCACHED_E2BIG
116
117 .. c:type:: MEMCACHED_INVALID_ARGUMENTS
118
119 .. c:type:: MEMCACHED_KEY_TOO_BIG
120
121 .. c:type:: MEMCACHED_AUTH_PROBLEM
122
123 .. c:type:: MEMCACHED_AUTH_FAILURE
124
125 .. c:type:: MEMCACHED_AUTH_CONTINUE
126
127 .. c:type:: MEMCACHED_PARSE_ERROR
128
129 .. c:type:: MEMCACHED_PARSE_USER_ERROR
130
131 .. c:type:: MEMCACHED_DEPRECATED
132
133 --------
134 SEE ALSO
135 --------
136
137 :manpage:`memcached(8)` :manpage:`libmemcached(3)` :manpage:`memcached_client_error()` or :manpage:`memcached_worker_error()`
138