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:: typedef 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. It is likely that either the number of file descriptors need to be increased or you are out of memory.
  61
  62     .. enumerator:: MEMCACHED_DATA_DOES_NOT_EXIST
  63
  64         The data requested with the key given was not found.
  65
  66     .. enumerator:: MEMCACHED_DATA_EXISTS
  67
  68         The data requested with the key given was not found.
  69
  70     .. enumerator:: MEMCACHED_DELETED
  71
  72         The object requested by the key has been deleted.
  73
  74     .. enumerator:: MEMCACHED_DEPRECATED
  75
  76         The method that was requested has been deprecated.
  77
  78     .. enumerator:: MEMCACHED_E2BIG
  79
  80         Item is too large for the server to store.
  81
  82     .. enumerator:: MEMCACHED_END
  83
  84         The server has completed returning all of the objects requested.
  85
  86     .. enumerator:: MEMCACHED_ERRNO
  87
  88         An error has occurred in the driver which has set errno.
  89
  90     .. enumerator:: MEMCACHED_FAIL_UNIX_SOCKET
  91
  92         A connection was not established with the server via a unix domain socket.
  93
  94     .. enumerator:: MEMCACHED_FAILURE
  95
  96         .. deprecated:: <0.30
  97
  98         A unknown failure has occurred in the server.
  99
 100     .. enumerator:: MEMCACHED_FETCH_NOTFINISHED
 101
 102         A request has been made, but the server has not finished the fetch of the last request.
 103
 104     .. enumerator:: MEMCACHED_HOST_LOOKUP_FAILURE
 105
 106         A DNS failure has occurred.
 107
 108     .. enumerator:: MEMCACHED_INVALID_ARGUMENTS
 109
 110         The arguments supplied to the given function were not valid.
 111
 112     .. enumerator:: MEMCACHED_INVALID_HOST_PROTOCOL
 113
 114         The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
 115
 116     .. enumerator:: MEMCACHED_ITEM
 117
 118         An item has been fetched (this is an internal error only).
 119
 120     .. enumerator:: MEMCACHED_KEY_TOO_BIG
 121
 122         The key that has been provided is too large for the given server.
 123
 124     .. enumerator:: MEMCACHED_MAXIMUM_RETURN
 125
 126         This in an internal only state.
 127
 128     .. enumerator:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
 129
 130         An error has occurred while trying to allocate memory.
 131
 132     .. enumerator:: MEMCACHED_NO_KEY_PROVIDED
 133
 134         .. deprecated:: <0.30
 135             Use `MEMCACHED_BAD_KEY_PROVIDED` instead.
 136
 137         No key was provided.
 138
 139     .. enumerator:: MEMCACHED_NO_SERVERS
 140
 141         No servers have been added to the memcached_st object.
 142
 143     .. enumerator:: MEMCACHED_NOTFOUND
 144
 145         The object requested was not found.
 146
 147     .. enumerator:: MEMCACHED_NOTSTORED
 148
 149         The request to store an object failed.
 150
 151     .. enumerator:: MEMCACHED_NOT_SUPPORTED
 152
 153         The given method is not supported in the server.
 154
 155     .. enumerator:: MEMCACHED_PARSE_ERROR
 156
 157         An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
 158
 159     .. enumerator:: MEMCACHED_PARSE_USER_ERROR
 160
 161         An error has occurred  in parsing the configuration string.
 162
 163     .. enumerator:: MEMCACHED_PARTIAL_READ
 164
 165         The read was only partially successful.
 166
 167     .. enumerator:: MEMCACHED_PROTOCOL_ERROR
 168
 169         An unknown error has occurred in the protocol.
 170
 171     .. enumerator:: MEMCACHED_READ_FAILURE
 172
 173         A read failure has occurred.
 174
 175     .. enumerator:: MEMCACHED_SERVER_ERROR
 176
 177         An unknown error has occurred in the server.
 178
 179     .. enumerator:: MEMCACHED_SERVER_MARKED_DEAD
 180
 181         The requested server has been marked dead.
 182
 183     .. enumerator:: MEMCACHED_SOME_ERRORS
 184
 185         A multi request has been made, and some undetermined number of errors have occurred.
 186
 187     .. enumerator:: MEMCACHED_STAT
 188
 189         A "stat" command has been returned in the protocol.
 190
 191     .. enumerator:: MEMCACHED_STORED
 192
 193         The requested object has been successfully stored on the server.
 194
 195     .. enumerator:: MEMCACHED_SUCCESS
 196
 197         The request was successfully executed.
 198
 199     .. enumerator:: MEMCACHED_TIMEOUT
 200
 201         Operation has timed out.
 202
 203     .. enumerator:: MEMCACHED_UNKNOWN_READ_FAILURE
 204
 205         An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
 206
 207     .. enumerator:: MEMCACHED_UNKNOWN_STAT_KEY
 208
 209         The server you are communicating with has a stat key which has not be defined in the protocol.
 210
 211     .. enumerator:: MEMCACHED_VALUE
 212
 213         A value has been returned from the server (this is an internal condition only).
 214
 215     .. enumerator:: MEMCACHED_WRITE_FAILURE
 216
 217         An error has occurred while trying to write to a server.
 218
 219 SEE ALSO
 220 --------
 221
 222 .. only:: man
 223
 224     :manpage:`memcached(1)`
 225     :manpage:`libmemcached(3)`
 226     :manpage:`memcached_strerror(3)`
 227
 228 .. only:: html
 229
 230     * :manpage:`memcached(1)`
 231     * :doc:`../libmemcached`
 232     * :doc:`memcached_strerror`
 233