Merge in docs.
[m6w6/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
29
30 .. c:type:: MEMCACHED_SUCCESS,
31
32 Success
33
34 .. c:type:: MEMCACHED_FAILURE,
35
36 .. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE, // getaddrinfo() only
37
38 .. c:type:: MEMCACHED_CONNECTION_FAILURE, // DEPRECATED
39
40 .. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE, // DEPRECATED
41
42 .. c:type:: MEMCACHED_WRITE_FAILURE,
43
44 .. c:type:: MEMCACHED_READ_FAILURE,
45
46 .. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE,
47
48 .. c:type:: MEMCACHED_PROTOCOL_ERROR,
49
50 .. c:type:: MEMCACHED_CLIENT_ERROR,
51
52 .. c:type:: MEMCACHED_SERVER_ERROR,
53
54 .. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE, // DEPRECATED
55
56 .. c:type:: MEMCACHED_DATA_EXISTS,
57
58 .. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST,
59
60 .. c:type:: MEMCACHED_NOTSTORED,
61
62 .. c:type:: MEMCACHED_STORED,
63
64 .. c:type:: MEMCACHED_NOTFOUND,
65
66 .. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE,
67
68 .. c:type:: MEMCACHED_PARTIAL_READ,
69
70 .. c:type:: MEMCACHED_SOME_ERRORS,
71
72 .. c:type:: MEMCACHED_NO_SERVERS,
73
74 .. c:type:: MEMCACHED_END,
75
76 .. c:type:: MEMCACHED_DELETED,
77
78 .. c:type:: MEMCACHED_VALUE,
79
80 .. c:type:: MEMCACHED_STAT,
81
82 .. c:type:: MEMCACHED_ITEM,
83
84 .. c:type:: MEMCACHED_ERRNO,
85
86 .. c:type:: MEMCACHED_FAIL_UNIX_SOCKET, // DEPRECATED
87
88 .. c:type:: MEMCACHED_NOT_SUPPORTED,
89
90 .. c:type:: MEMCACHED_NO_KEY_PROVIDED, /* Deprecated. Use MEMCACHED_BAD_KEY_PROVIDED! */
91
92 .. c:type:: MEMCACHED_FETCH_NOTFINISHED,
93
94 .. c:type:: MEMCACHED_TIMEOUT,
95
96 Connection to server timed out.
97
98 .. c:type:: MEMCACHED_BUFFERED,
99
100 .. c:type:: MEMCACHED_BAD_KEY_PROVIDED,
101
102 .. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL,
103
104 .. c:type:: MEMCACHED_SERVER_MARKED_DEAD,
105
106 .. c:type:: MEMCACHED_UNKNOWN_STAT_KEY,
107
108 .. c:type:: MEMCACHED_E2BIG,
109
110 .. c:type:: MEMCACHED_INVALID_ARGUMENTS,
111
112 .. c:type:: MEMCACHED_KEY_TOO_BIG,
113
114 .. c:type:: MEMCACHED_AUTH_PROBLEM,
115
116 .. c:type:: MEMCACHED_AUTH_FAILURE,
117
118 .. c:type:: MEMCACHED_AUTH_CONTINUE,
119
120 .. c:type:: MEMCACHED_PARSE_ERROR,
121
122 .. c:type:: MEMCACHED_PARSE_USER_ERROR,
123
124 .. c:type:: MEMCACHED_DEPRECATED,
125
126 .. c:type:: MEMCACHED_MAXIMUM_RETURN /* Always add new error code before */
127
128 --------
129 SEE ALSO
130 --------
131
132 :manpage:`memcached(8)` :manpage:`libmemcached(3)` :manpage:`memcached_client_error()` or :manpage:`memcached_worker_error()`
133