git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_return_t.rst

   1 Error Codes - memcached_return_t
   2 ================================
   3
   4 SYNOPSIS
   5 --------
   6
   7 #include <libmemcached/memcached.h>
   8   Compile and link with -lmemcached
   9
  10 .. function:: bool memcached_success(memcached_return_t)
  11
  12 .. function:: bool memcached_continue(memcached_return_t rc)
  13
  14 .. function:: bool memcached_failed(memcached_return_t)
  15
  16 .. function:: bool memcached_fatal(memcached_return_t)
  17
  18 .. c:type:: enum memcached_return_t memcached_return_t
  19
  20 .. enum:: memcached_return_t
  21
  22     .. enumerator:: MEMCACHED_AUTH_CONTINUE
  23
  24         Authentication has been paused.
  25
  26     .. enumerator:: MEMCACHED_AUTH_FAILURE
  27
  28         The credentials provided are not valid for this server.
  29
  30     .. enumerator:: MEMCACHED_AUTH_PROBLEM
  31
  32         An unknown issue has occurred during authentication.
  33
  34     .. enumerator:: MEMCACHED_BAD_KEY_PROVIDED
  35
  36         The key provided is not a valid key.
  37
  38     .. enumerator:: MEMCACHED_BUFFERED
  39
  40         The request has been buffered.
  41
  42     .. enumerator:: MEMCACHED_CLIENT_ERROR
  43
  44         An unknown client error has occurred internally.
  45
  46     .. enumerator:: MEMCACHED_CONNECTION_BIND_FAILURE
  47
  48         .. deprecated:: <0.30
  49
  50         We were not able to bind() to the socket.
  51
  52     .. enumerator:: MEMCACHED_CONNECTION_FAILURE
  53
  54         A unknown error has occurred while trying to connect to a server.
  55
  56     .. enumerator:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
  57
  58         .. deprecated:: <0.30
  59
  60         An error has occurred while trying to connect to a server.
  61         It is likely that either the number of file descriptors need to be increased or you are out of memory.
  62
  63     .. enumerator:: MEMCACHED_DATA_DOES_NOT_EXIST
  64
  65         The data requested with the key given was not found.
  66
  67     .. enumerator:: MEMCACHED_DATA_EXISTS
  68
  69         The data requested with the key given was not found.
  70
  71     .. enumerator:: MEMCACHED_DELETED
  72
  73         The object requested by the key has been deleted.
  74
  75     .. enumerator:: MEMCACHED_DEPRECATED
  76
  77         The method that was requested has been deprecated.
  78
  79     .. enumerator:: MEMCACHED_E2BIG
  80
  81         Item is too large for the server to store.
  82
  83     .. enumerator:: MEMCACHED_END
  84
  85         The server has completed returning all of the objects requested.
  86
  87     .. enumerator:: MEMCACHED_ERRNO
  88
  89         An error has occurred in the driver which has set errno.
  90
  91     .. enumerator:: MEMCACHED_FAIL_UNIX_SOCKET
  92
  93         A connection was not established with the server via a unix domain socket.
  94
  95     .. enumerator:: MEMCACHED_FAILURE
  96
  97         .. deprecated:: <0.30
  98
  99         A unknown failure has occurred in the server.
 100
 101     .. enumerator:: MEMCACHED_FETCH_NOTFINISHED
 102
 103         A request has been made, but the server has not finished the fetch of the last request.
 104
 105     .. enumerator:: MEMCACHED_HOST_LOOKUP_FAILURE
 106
 107         A DNS failure has occurred.
 108
 109     .. enumerator:: MEMCACHED_INVALID_ARGUMENTS
 110
 111         The arguments supplied to the given function were not valid.
 112
 113     .. enumerator:: MEMCACHED_INVALID_HOST_PROTOCOL
 114
 115         The server you are connecting too has an invalid protocol.
 116         Most likely you are connecting to an older server that does not speak the binary protocol.
 117
 118     .. enumerator:: MEMCACHED_ITEM
 119
 120         An item has been fetched (this is an internal error only).
 121
 122     .. enumerator:: MEMCACHED_KEY_TOO_BIG
 123
 124         The key that has been provided is too large for the given server.
 125
 126     .. enumerator:: MEMCACHED_MAXIMUM_RETURN
 127
 128         This in an internal only state.
 129
 130     .. enumerator:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
 131
 132         An error has occurred while trying to allocate memory.
 133
 134     .. enumerator:: MEMCACHED_NO_KEY_PROVIDED
 135
 136         .. deprecated:: <0.30
 137             Use `MEMCACHED_BAD_KEY_PROVIDED` instead.
 138
 139         No key was provided.
 140
 141     .. enumerator:: MEMCACHED_NO_SERVERS
 142
 143         No servers have been added to the memcached_st object.
 144
 145     .. enumerator:: MEMCACHED_NOTFOUND
 146
 147         The object requested was not found.
 148
 149     .. enumerator:: MEMCACHED_NOTSTORED
 150
 151         The request to store an object failed.
 152
 153     .. enumerator:: MEMCACHED_NOT_SUPPORTED
 154
 155         The given method is not supported in the server.
 156
 157     .. enumerator:: MEMCACHED_PARSE_ERROR
 158
 159         An error has occurred while trying to parse the configuration string.
 160         You should use memparse to determine what the error was.
 161
 162     .. enumerator:: MEMCACHED_PARSE_USER_ERROR
 163
 164         An error has occurred  in parsing the configuration string.
 165
 166     .. enumerator:: MEMCACHED_PARTIAL_READ
 167
 168         The read was only partially successful.
 169
 170     .. enumerator:: MEMCACHED_PROTOCOL_ERROR
 171
 172         An unknown error has occurred in the protocol.
 173
 174     .. enumerator:: MEMCACHED_READ_FAILURE
 175
 176         A read failure has occurred.
 177
 178     .. enumerator:: MEMCACHED_SERVER_ERROR
 179
 180         An unknown error has occurred in the server.
 181
 182     .. enumerator:: MEMCACHED_SERVER_MARKED_DEAD
 183
 184         The requested server has been marked dead.
 185
 186     .. enumerator:: MEMCACHED_SOME_ERRORS
 187
 188         A multi request has been made, and some undetermined number of errors have occurred.
 189
 190     .. enumerator:: MEMCACHED_STAT
 191
 192         A "stat" command has been returned in the protocol.
 193
 194     .. enumerator:: MEMCACHED_STORED
 195
 196         The requested object has been successfully stored on the server.
 197
 198     .. enumerator:: MEMCACHED_SUCCESS
 199
 200         The request was successfully executed.
 201
 202     .. enumerator:: MEMCACHED_TIMEOUT
 203
 204         Operation has timed out.
 205
 206     .. enumerator:: MEMCACHED_UNKNOWN_READ_FAILURE
 207
 208         An unknown read failure only occurs when either there is a bug in the server,
 209         or in rare cases where an ethernet nic is reporting dubious information.
 210
 211     .. enumerator:: MEMCACHED_UNKNOWN_STAT_KEY
 212
 213         The server you are communicating with has a stat key which has not be defined in the protocol.
 214
 215     .. enumerator:: MEMCACHED_VALUE
 216
 217         A value has been returned from the server (this is an internal condition only).
 218
 219     .. enumerator:: MEMCACHED_WRITE_FAILURE
 220
 221         An error has occurred while trying to write to a server.
 222
 223 SEE ALSO
 224 --------
 225
 226 .. only:: man
 227
 228     :manpage:`memcached(1)`
 229     :manpage:`libmemcached(3)`
 230     :manpage:`memcached_strerror(3)`
 231
 232 .. only:: html
 233
 234     * :manpage:`memcached(1)`
 235     * :doc:`../libmemcached`
 236     * :doc:`memcached_strerror`
 237