memcached  1.6.15
About: memcached is a high-performance, distributed memory object caching system, generic in nature, but originally intended for use in speeding up dynamic web applications by alleviating database load.
  Fossies Dox: memcached-1.6.15.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

protocol_binary.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

union  protocol_binary_request_header
 
union  protocol_binary_response_header
 
union  protocol_binary_request_no_extras
 
union  protocol_binary_response_no_extras
 
union  protocol_binary_response_get
 
union  protocol_binary_request_flush
 
union  protocol_binary_request_set
 
union  protocol_binary_request_incr
 
union  protocol_binary_response_incr
 
union  protocol_binary_request_touch
 
union  protocol_binary_request_gat
 
union  protocol_binary_request_rangeop
 

Typedefs

typedef protocol_binary_request_no_extras protocol_binary_request_get
 
typedef protocol_binary_request_no_extras protocol_binary_request_getq
 
typedef protocol_binary_request_no_extras protocol_binary_request_getk
 
typedef protocol_binary_request_no_extras protocol_binary_request_getkq
 
typedef protocol_binary_response_get protocol_binary_response_getq
 
typedef protocol_binary_response_get protocol_binary_response_getk
 
typedef protocol_binary_response_get protocol_binary_response_getkq
 
typedef protocol_binary_request_no_extras protocol_binary_request_delete
 
typedef protocol_binary_response_no_extras protocol_binary_response_delete
 
typedef protocol_binary_response_no_extras protocol_binary_response_flush
 
typedef protocol_binary_request_set protocol_binary_request_add
 
typedef protocol_binary_request_set protocol_binary_request_replace
 
typedef protocol_binary_response_no_extras protocol_binary_response_set
 
typedef protocol_binary_response_no_extras protocol_binary_response_add
 
typedef protocol_binary_response_no_extras protocol_binary_response_replace
 
typedef protocol_binary_request_no_extras protocol_binary_request_noop
 
typedef protocol_binary_response_no_extras protocol_binary_response_noop
 
typedef protocol_binary_request_incr protocol_binary_request_decr
 
typedef protocol_binary_response_incr protocol_binary_response_decr
 
typedef protocol_binary_request_no_extras protocol_binary_request_quit
 
typedef protocol_binary_response_no_extras protocol_binary_response_quit
 
typedef protocol_binary_request_no_extras protocol_binary_request_append
 
typedef protocol_binary_request_no_extras protocol_binary_request_prepend
 
typedef protocol_binary_response_no_extras protocol_binary_response_append
 
typedef protocol_binary_response_no_extras protocol_binary_response_prepend
 
typedef protocol_binary_request_no_extras protocol_binary_request_version
 
typedef protocol_binary_response_no_extras protocol_binary_response_version
 
typedef protocol_binary_request_no_extras protocol_binary_request_stats
 
typedef protocol_binary_response_no_extras protocol_binary_response_stats
 
typedef protocol_binary_response_no_extras protocol_binary_response_touch
 
typedef protocol_binary_request_gat protocol_binary_request_gatq
 
typedef protocol_binary_request_gat protocol_binary_request_gatk
 
typedef protocol_binary_request_gat protocol_binary_request_gatkq
 
typedef protocol_binary_response_get protocol_binary_response_gat
 
typedef protocol_binary_response_get protocol_binary_response_gatq
 
typedef protocol_binary_response_get protocol_binary_response_gatk
 
typedef protocol_binary_response_get protocol_binary_response_gatkq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rget
 
typedef protocol_binary_request_rangeop protocol_binary_request_rset
 
typedef protocol_binary_request_rangeop protocol_binary_request_rsetq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rappend
 
typedef protocol_binary_request_rangeop protocol_binary_request_rappendq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rprepend
 
typedef protocol_binary_request_rangeop protocol_binary_request_rprependq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rdelete
 
typedef protocol_binary_request_rangeop protocol_binary_request_rdeleteq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rincr
 
typedef protocol_binary_request_rangeop protocol_binary_request_rincrq
 
typedef protocol_binary_request_rangeop protocol_binary_request_rdecr
 
typedef protocol_binary_request_rangeop protocol_binary_request_rdecrq
 

Enumerations

enum  protocol_binary_magic { PROTOCOL_BINARY_REQ = 0x80 , PROTOCOL_BINARY_RES = 0x81 }
 
enum  protocol_binary_response_status {
  PROTOCOL_BINARY_RESPONSE_SUCCESS = 0x00 , PROTOCOL_BINARY_RESPONSE_KEY_ENOENT = 0x01 , PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS = 0x02 , PROTOCOL_BINARY_RESPONSE_E2BIG = 0x03 ,
  PROTOCOL_BINARY_RESPONSE_EINVAL = 0x04 , PROTOCOL_BINARY_RESPONSE_NOT_STORED = 0x05 , PROTOCOL_BINARY_RESPONSE_DELTA_BADVAL = 0x06 , PROTOCOL_BINARY_RESPONSE_AUTH_ERROR = 0x20 ,
  PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE = 0x21 , PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND = 0x81 , PROTOCOL_BINARY_RESPONSE_ENOMEM = 0x82
}
 
enum  protocol_binary_command {
  PROTOCOL_BINARY_CMD_GET = 0x00 , PROTOCOL_BINARY_CMD_SET = 0x01 , PROTOCOL_BINARY_CMD_ADD = 0x02 , PROTOCOL_BINARY_CMD_REPLACE = 0x03 ,
  PROTOCOL_BINARY_CMD_DELETE = 0x04 , PROTOCOL_BINARY_CMD_INCREMENT = 0x05 , PROTOCOL_BINARY_CMD_DECREMENT = 0x06 , PROTOCOL_BINARY_CMD_QUIT = 0x07 ,
  PROTOCOL_BINARY_CMD_FLUSH = 0x08 , PROTOCOL_BINARY_CMD_GETQ = 0x09 , PROTOCOL_BINARY_CMD_NOOP = 0x0a , PROTOCOL_BINARY_CMD_VERSION = 0x0b ,
  PROTOCOL_BINARY_CMD_GETK = 0x0c , PROTOCOL_BINARY_CMD_GETKQ = 0x0d , PROTOCOL_BINARY_CMD_APPEND = 0x0e , PROTOCOL_BINARY_CMD_PREPEND = 0x0f ,
  PROTOCOL_BINARY_CMD_STAT = 0x10 , PROTOCOL_BINARY_CMD_SETQ = 0x11 , PROTOCOL_BINARY_CMD_ADDQ = 0x12 , PROTOCOL_BINARY_CMD_REPLACEQ = 0x13 ,
  PROTOCOL_BINARY_CMD_DELETEQ = 0x14 , PROTOCOL_BINARY_CMD_INCREMENTQ = 0x15 , PROTOCOL_BINARY_CMD_DECREMENTQ = 0x16 , PROTOCOL_BINARY_CMD_QUITQ = 0x17 ,
  PROTOCOL_BINARY_CMD_FLUSHQ = 0x18 , PROTOCOL_BINARY_CMD_APPENDQ = 0x19 , PROTOCOL_BINARY_CMD_PREPENDQ = 0x1a , PROTOCOL_BINARY_CMD_TOUCH = 0x1c ,
  PROTOCOL_BINARY_CMD_GAT = 0x1d , PROTOCOL_BINARY_CMD_GATQ = 0x1e , PROTOCOL_BINARY_CMD_GATK = 0x23 , PROTOCOL_BINARY_CMD_GATKQ = 0x24 ,
  PROTOCOL_BINARY_CMD_SASL_LIST_MECHS = 0x20 , PROTOCOL_BINARY_CMD_SASL_AUTH = 0x21 , PROTOCOL_BINARY_CMD_SASL_STEP = 0x22 , PROTOCOL_BINARY_CMD_RGET = 0x30 ,
  PROTOCOL_BINARY_CMD_RSET = 0x31 , PROTOCOL_BINARY_CMD_RSETQ = 0x32 , PROTOCOL_BINARY_CMD_RAPPEND = 0x33 , PROTOCOL_BINARY_CMD_RAPPENDQ = 0x34 ,
  PROTOCOL_BINARY_CMD_RPREPEND = 0x35 , PROTOCOL_BINARY_CMD_RPREPENDQ = 0x36 , PROTOCOL_BINARY_CMD_RDELETE = 0x37 , PROTOCOL_BINARY_CMD_RDELETEQ = 0x38 ,
  PROTOCOL_BINARY_CMD_RINCR = 0x39 , PROTOCOL_BINARY_CMD_RINCRQ = 0x3a , PROTOCOL_BINARY_CMD_RDECR = 0x3b , PROTOCOL_BINARY_CMD_RDECRQ = 0x3c
}
 
enum  protocol_binary_datatypes { PROTOCOL_BINARY_RAW_BYTES = 0x00 }
 

Typedef Documentation

◆ protocol_binary_request_add

◆ protocol_binary_request_append

Definition of the packet used by append and prepend command See section 4

Definition at line 354 of file protocol_binary.h.

◆ protocol_binary_request_decr

◆ protocol_binary_request_delete

Definition of the packet used by the delete command See section 4

Definition at line 237 of file protocol_binary.h.

◆ protocol_binary_request_gatk

◆ protocol_binary_request_gatkq

◆ protocol_binary_request_gatq

◆ protocol_binary_request_get

Definition of the packet used by the get, getq, getk and getkq command. See section 4

Definition at line 209 of file protocol_binary.h.

◆ protocol_binary_request_getk

◆ protocol_binary_request_getkq

◆ protocol_binary_request_getq

◆ protocol_binary_request_noop

Definition of the noop packet See section 4

Definition at line 296 of file protocol_binary.h.

◆ protocol_binary_request_prepend

◆ protocol_binary_request_quit

Definition of the quit See section 4

Definition at line 342 of file protocol_binary.h.

◆ protocol_binary_request_rappend

◆ protocol_binary_request_rappendq

◆ protocol_binary_request_rdecr

◆ protocol_binary_request_rdecrq

◆ protocol_binary_request_rdelete

◆ protocol_binary_request_rdeleteq

◆ protocol_binary_request_replace

◆ protocol_binary_request_rget

◆ protocol_binary_request_rincr

◆ protocol_binary_request_rincrq

◆ protocol_binary_request_rprepend

◆ protocol_binary_request_rprependq

◆ protocol_binary_request_rset

◆ protocol_binary_request_rsetq

◆ protocol_binary_request_stats

Definition of the packet used by the stats command. See section 4

Definition at line 381 of file protocol_binary.h.

◆ protocol_binary_request_version

Definition of the packet used by the version command See section 4

Definition at line 368 of file protocol_binary.h.

◆ protocol_binary_response_add

◆ protocol_binary_response_append

Definition of the packet returned from a successful append or prepend See section 4

Definition at line 361 of file protocol_binary.h.

◆ protocol_binary_response_decr

◆ protocol_binary_response_delete

Definition of the packet returned by the delete command See section 4

Definition at line 243 of file protocol_binary.h.

◆ protocol_binary_response_flush

Definition of the packet returned by the flush command See section 4

Definition at line 265 of file protocol_binary.h.

◆ protocol_binary_response_gat

Definition of the packet returned from the GAT(Q)

Definition at line 427 of file protocol_binary.h.

◆ protocol_binary_response_gatk

◆ protocol_binary_response_gatkq

◆ protocol_binary_response_gatq

◆ protocol_binary_response_getk

◆ protocol_binary_response_getkq

◆ protocol_binary_response_getq

◆ protocol_binary_response_noop

Definition of the packet returned by the noop command See section 4

Definition at line 302 of file protocol_binary.h.

◆ protocol_binary_response_prepend

◆ protocol_binary_response_quit

Definition of the packet returned by the quit command See section 4

Definition at line 348 of file protocol_binary.h.

◆ protocol_binary_response_replace

◆ protocol_binary_response_set

Definition of the packet returned by set, add and replace See section 4

Definition at line 288 of file protocol_binary.h.

◆ protocol_binary_response_stats

Definition of the packet returned from a successful stats command See section 4

Definition at line 387 of file protocol_binary.h.

◆ protocol_binary_response_touch

Definition of the packet returned from the touch command

Definition at line 405 of file protocol_binary.h.

◆ protocol_binary_response_version

Definition of the packet returned from a successful version command See section 4

Definition at line 374 of file protocol_binary.h.

Enumeration Type Documentation

◆ protocol_binary_command

Definition of the different command opcodes. See section 3.3 Command Opcodes

Enumerator
PROTOCOL_BINARY_CMD_GET 
PROTOCOL_BINARY_CMD_SET 
PROTOCOL_BINARY_CMD_ADD 
PROTOCOL_BINARY_CMD_REPLACE 
PROTOCOL_BINARY_CMD_DELETE 
PROTOCOL_BINARY_CMD_INCREMENT 
PROTOCOL_BINARY_CMD_DECREMENT 
PROTOCOL_BINARY_CMD_QUIT 
PROTOCOL_BINARY_CMD_FLUSH 
PROTOCOL_BINARY_CMD_GETQ 
PROTOCOL_BINARY_CMD_NOOP 
PROTOCOL_BINARY_CMD_VERSION 
PROTOCOL_BINARY_CMD_GETK 
PROTOCOL_BINARY_CMD_GETKQ 
PROTOCOL_BINARY_CMD_APPEND 
PROTOCOL_BINARY_CMD_PREPEND 
PROTOCOL_BINARY_CMD_STAT 
PROTOCOL_BINARY_CMD_SETQ 
PROTOCOL_BINARY_CMD_ADDQ 
PROTOCOL_BINARY_CMD_REPLACEQ 
PROTOCOL_BINARY_CMD_DELETEQ 
PROTOCOL_BINARY_CMD_INCREMENTQ 
PROTOCOL_BINARY_CMD_DECREMENTQ 
PROTOCOL_BINARY_CMD_QUITQ 
PROTOCOL_BINARY_CMD_FLUSHQ 
PROTOCOL_BINARY_CMD_APPENDQ 
PROTOCOL_BINARY_CMD_PREPENDQ 
PROTOCOL_BINARY_CMD_TOUCH 
PROTOCOL_BINARY_CMD_GAT 
PROTOCOL_BINARY_CMD_GATQ 
PROTOCOL_BINARY_CMD_GATK 
PROTOCOL_BINARY_CMD_GATKQ 
PROTOCOL_BINARY_CMD_SASL_LIST_MECHS 
PROTOCOL_BINARY_CMD_SASL_AUTH 
PROTOCOL_BINARY_CMD_SASL_STEP 
PROTOCOL_BINARY_CMD_RGET 
PROTOCOL_BINARY_CMD_RSET 
PROTOCOL_BINARY_CMD_RSETQ 
PROTOCOL_BINARY_CMD_RAPPEND 
PROTOCOL_BINARY_CMD_RAPPENDQ 
PROTOCOL_BINARY_CMD_RPREPEND 
PROTOCOL_BINARY_CMD_RPREPENDQ 
PROTOCOL_BINARY_CMD_RDELETE 
PROTOCOL_BINARY_CMD_RDELETEQ 
PROTOCOL_BINARY_CMD_RINCR 
PROTOCOL_BINARY_CMD_RINCRQ 
PROTOCOL_BINARY_CMD_RDECR 
PROTOCOL_BINARY_CMD_RDECRQ 

Definition at line 80 of file protocol_binary.h.

◆ protocol_binary_datatypes

Definition of the data types in the packet See section 3.4 Data Types

Enumerator
PROTOCOL_BINARY_RAW_BYTES 

Definition at line 143 of file protocol_binary.h.

◆ protocol_binary_magic

This file contains definitions of the constants and packet formats defined in the binary specification. Please note that you MUST remember to convert each multibyte field to / from network byte order to / from host order. Definition of the legal "magic" values used in a packet. See section 3.1 Magic byte

Enumerator
PROTOCOL_BINARY_REQ 
PROTOCOL_BINARY_RES 

Definition at line 53 of file protocol_binary.h.

◆ protocol_binary_response_status

Definition of the valid response status numbers. See section 3.2 Response Status

Enumerator
PROTOCOL_BINARY_RESPONSE_SUCCESS 
PROTOCOL_BINARY_RESPONSE_KEY_ENOENT 
PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS 
PROTOCOL_BINARY_RESPONSE_E2BIG 
PROTOCOL_BINARY_RESPONSE_EINVAL 
PROTOCOL_BINARY_RESPONSE_NOT_STORED 
PROTOCOL_BINARY_RESPONSE_DELTA_BADVAL 
PROTOCOL_BINARY_RESPONSE_AUTH_ERROR 
PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE 
PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND 
PROTOCOL_BINARY_RESPONSE_ENOMEM 

Definition at line 62 of file protocol_binary.h.