docs: memcached_return_t (fix #72) [ci skip]
[awesomized/libmemcached] / docs / source / 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 *memcached_strerror(memcached_st *ptr, memcached_return_t rc)
14
15 .. c:function:: bool memcached_success(memcached_return_t)
16
17 .. c:function:: bool memcached_continue(memcached_return_t rc)
18
19 .. c:function:: bool memcached_failed(memcached_return_t)
20
21 .. c:function:: bool memcached_fatal(memcached_return_t)
22
23
24 Libmemcached return types:
25 ++++++++++++++++++++++++++
26
27
28 :c:type:`MEMCACHED_SUCCESS`
29
30 :c:type:`MEMCACHED_FAILURE`
31
32 :c:type:`MEMCACHED_HOST_LOOKUP_FAILURE`
33
34 :c:type:`MEMCACHED_CONNECTION_FAILURE`
35
36 :c:type:`MEMCACHED_CONNECTION_BIND_FAILURE`
37
38 :c:type:`MEMCACHED_WRITE_FAILURE`
39
40 :c:type:`MEMCACHED_READ_FAILURE`
41
42 :c:type:`MEMCACHED_UNKNOWN_READ_FAILURE`
43
44 :c:type:`MEMCACHED_PROTOCOL_ERROR`
45
46 :c:type:`MEMCACHED_CLIENT_ERROR`
47
48 :c:type:`MEMCACHED_SERVER_ERROR`
49
50 :c:type:`MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE`
51
52 :c:type:`MEMCACHED_DATA_EXISTS`
53
54 :c:type:`MEMCACHED_DATA_DOES_NOT_EXIST`
55
56 :c:type:`MEMCACHED_NOTSTORED`
57
58 :c:type:`MEMCACHED_STORED`
59
60 :c:type:`MEMCACHED_NOTFOUND`
61
62 :c:type:`MEMCACHED_MEMORY_ALLOCATION_FAILURE`
63
64 :c:type:`MEMCACHED_PARTIAL_READ`
65
66 :c:type:`MEMCACHED_SOME_ERRORS`
67
68 :c:type:`MEMCACHED_NO_SERVERS`
69
70 :c:type:`MEMCACHED_END`
71
72 :c:type:`MEMCACHED_DELETED`
73
74 :c:type:`MEMCACHED_VALUE`
75
76 :c:type:`MEMCACHED_STAT`
77
78 :c:type:`MEMCACHED_ITEM`
79
80 :c:type:`MEMCACHED_ERRNO`
81
82 :c:type:`MEMCACHED_FAIL_UNIX_SOCKET`
83
84 :c:type:`MEMCACHED_NOT_SUPPORTED`
85
86 :c:type:`MEMCACHED_NO_KEY_PROVIDED`
87
88 :c:type:`MEMCACHED_FETCH_NOTFINISHED`
89
90 :c:type:`MEMCACHED_TIMEOUT`
91
92 :c:type:`MEMCACHED_BUFFERED`
93
94 :c:type:`MEMCACHED_BAD_KEY_PROVIDED`
95
96 :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`
97
98 :c:type:`MEMCACHED_SERVER_MARKED_DEAD`
99
100 :c:type:`MEMCACHED_UNKNOWN_STAT_KEY`
101
102 :c:type:`MEMCACHED_E2BIG`
103
104 :c:type:`MEMCACHED_INVALID_ARGUMENTS`
105
106 :c:type:`MEMCACHED_KEY_TOO_BIG`
107
108 :c:type:`MEMCACHED_AUTH_PROBLEM`
109
110 :c:type:`MEMCACHED_AUTH_FAILURE`
111
112 :c:type:`MEMCACHED_AUTH_CONTINUE`
113
114 :c:type:`MEMCACHED_PARSE_ERROR`
115
116 :c:type:`MEMCACHED_PARSE_USER_ERROR`
117
118 :c:type:`MEMCACHED_DEPRECATED`
119
120 :c:type:`MEMCACHED_UNIX_SOCKET_PATH_TOO_BIG`
121
122 --------
123 SEE ALSO
124 --------
125
126 :manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_client_error` or :manpage:`memcached_worker_error`