MySQL 5.6.14 Source Code Document
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Typedefs | Enumerations
Binary Protocol Structures

Classes

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_verbosity
union  protocol_binary_request_touch
union  protocol_binary_request_gat
union  protocol_binary_request_rangeop
union  protocol_binary_request_tap_connect
union  protocol_binary_request_tap_mutation
union  protocol_binary_request_tap_no_extras
union  protocol_binary_request_set_vbucket
union  protocol_binary_response_get_vbucket

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_verbosity
typedef
protocol_binary_response_no_extras 		protocol_binary_response_touch
typedef protocol_binary_request_gat protocol_binary_request_gatq
typedef
protocol_binary_response_get 		protocol_binary_response_gat
typedef
protocol_binary_response_get 		protocol_binary_response_gatq
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
typedef
protocol_binary_request_tap_no_extras 		protocol_binary_request_tap_delete
typedef
protocol_binary_request_tap_no_extras 		protocol_binary_request_tap_flush
typedef
protocol_binary_request_tap_no_extras 		protocol_binary_request_tap_opaque
typedef
protocol_binary_request_tap_no_extras 		protocol_binary_request_tap_vbucket_set
typedef
protocol_binary_request_no_extras 		protocol_binary_request_scrub
typedef
protocol_binary_response_no_extras 		protocol_binary_response_scrub
typedef
protocol_binary_response_no_extras 		protocol_binary_response_set_vbucket
typedef
protocol_binary_request_no_extras 		protocol_binary_request_del_vbucket
typedef
protocol_binary_response_no_extras 		protocol_binary_response_del_vbucket
typedef
protocol_binary_request_no_extras 		protocol_binary_request_get_vbucket

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_NOT_MY_VBUCKET = 0x07,
  PROTOCOL_BINARY_RESPONSE_AUTH_ERROR = 0x20, PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE = 0x21, PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND = 0x81, PROTOCOL_BINARY_RESPONSE_ENOMEM = 0x82,
  PROTOCOL_BINARY_RESPONSE_NOT_SUPPORTED = 0x83, PROTOCOL_BINARY_RESPONSE_EINTERNAL = 0x84, PROTOCOL_BINARY_RESPONSE_EBUSY = 0x85, PROTOCOL_BINARY_RESPONSE_ETMPFAIL = 0x86
}
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_VERBOSITY = 0x1b,
  PROTOCOL_BINARY_CMD_TOUCH = 0x1c, PROTOCOL_BINARY_CMD_GAT = 0x1d, PROTOCOL_BINARY_CMD_GATQ = 0x1e, 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, PROTOCOL_BINARY_CMD_SET_VBUCKET = 0x3d,
  PROTOCOL_BINARY_CMD_GET_VBUCKET = 0x3e, PROTOCOL_BINARY_CMD_DEL_VBUCKET = 0x3f, PROTOCOL_BINARY_CMD_TAP_CONNECT = 0x40, PROTOCOL_BINARY_CMD_TAP_MUTATION = 0x41,
  PROTOCOL_BINARY_CMD_TAP_DELETE = 0x42, PROTOCOL_BINARY_CMD_TAP_FLUSH = 0x43, PROTOCOL_BINARY_CMD_TAP_OPAQUE = 0x44, PROTOCOL_BINARY_CMD_TAP_VBUCKET_SET = 0x45,
  PROTOCOL_BINARY_CMD_TAP_CHECKPOINT_START = 0x46, PROTOCOL_BINARY_CMD_TAP_CHECKPOINT_END = 0x47, PROTOCOL_BINARY_CMD_LAST_RESERVED = 0x8f, PROTOCOL_BINARY_CMD_SCRUB = 0xf0
}
enum  protocol_binary_datatypes { PROTOCOL_BINARY_RAW_BYTES = 0x00 }

Detailed Description

Typedef Documentation

typedef protocol_binary_request_no_extras protocol_binary_request_append

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

Definition at line 388 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_del_vbucket

Definition of the packet used by del vbucket

Definition at line 694 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_delete

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

Definition at line 271 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_get

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

Definition at line 243 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_get_vbucket

Definition of the packet used by get vbucket

Definition at line 703 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_noop

Definition of the noop packet See section 4

Definition at line 330 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_quit

Definition of the quit See section 4

Definition at line 376 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_scrub

Definition of the packet used by the scrub.

Definition at line 667 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_stats

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

Definition at line 415 of file protocol_binary.h.

typedef protocol_binary_request_no_extras protocol_binary_request_version

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

Definition at line 402 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_append

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

Definition at line 395 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_del_vbucket

Definition of the packet returned from del vbucket

Definition at line 698 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_delete

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

Definition at line 277 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_flush

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

Definition at line 299 of file protocol_binary.h.

typedef protocol_binary_response_get protocol_binary_response_gat

Definition of the packet returned from the GAT(Q)

Definition at line 477 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_noop

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

Definition at line 336 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_quit

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

Definition at line 382 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_scrub

Definition of the packet returned from scrub.

Definition at line 672 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_set

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

Definition at line 322 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_set_vbucket

Definition of the packet returned from set vbucket

Definition at line 690 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_stats

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

Definition at line 421 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_touch

Definition of the packet returned from the touch command

Definition at line 457 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_verbosity

Definition of the packet returned from the verbosity command

Definition at line 439 of file protocol_binary.h.

typedef protocol_binary_response_no_extras protocol_binary_response_version

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

Definition at line 408 of file protocol_binary.h.

Enumeration Type Documentation

enum protocol_binary_command

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

Definition at line 94 of file protocol_binary.h.

enum protocol_binary_datatypes

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

Definition at line 177 of file protocol_binary.h.

enum 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

Definition at line 62 of file protocol_binary.h.

enum protocol_binary_response_status

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

Definition at line 71 of file protocol_binary.h.