osbzr
/
com
项目红包剩余9514，下一贡献奖励5%，即 476个红包
Watch 15
Star 7
Wiki 捐赠
本站源代码
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 4f0cac5ea6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4f0cac5ea6'
${ noResults }
com/vendor/github.com/couchbase/gomemcached/mc_constants.go

346 lines
11KB
Raw Blame History 

  1. // Package gomemcached is binary protocol packet formats and constants.

  2. package gomemcached

  3. 

  4. import (

  5. 	"fmt"

  6. )

  7. 

  8. const (

  9. 	REQ_MAGIC = 0x80

  10. 	RES_MAGIC = 0x81

  11. )

  12. 

  13. // CommandCode for memcached packets.

  14. type CommandCode uint8

  15. 

  16. const (

  17. 	GET        = CommandCode(0x00)

  18. 	SET        = CommandCode(0x01)

  19. 	ADD        = CommandCode(0x02)

  20. 	REPLACE    = CommandCode(0x03)

  21. 	DELETE     = CommandCode(0x04)

  22. 	INCREMENT  = CommandCode(0x05)

  23. 	DECREMENT  = CommandCode(0x06)

  24. 	QUIT       = CommandCode(0x07)

  25. 	FLUSH      = CommandCode(0x08)

  26. 	GETQ       = CommandCode(0x09)

  27. 	NOOP       = CommandCode(0x0a)

  28. 	VERSION    = CommandCode(0x0b)

  29. 	GETK       = CommandCode(0x0c)

  30. 	GETKQ      = CommandCode(0x0d)

  31. 	APPEND     = CommandCode(0x0e)

  32. 	PREPEND    = CommandCode(0x0f)

  33. 	STAT       = CommandCode(0x10)

  34. 	SETQ       = CommandCode(0x11)

  35. 	ADDQ       = CommandCode(0x12)

  36. 	REPLACEQ   = CommandCode(0x13)

  37. 	DELETEQ    = CommandCode(0x14)

  38. 	INCREMENTQ = CommandCode(0x15)

  39. 	DECREMENTQ = CommandCode(0x16)

  40. 	QUITQ      = CommandCode(0x17)

  41. 	FLUSHQ     = CommandCode(0x18)

  42. 	APPENDQ    = CommandCode(0x19)

  43. 	AUDIT      = CommandCode(0x27)

  44. 	PREPENDQ   = CommandCode(0x1a)

  45. 	GAT        = CommandCode(0x1d)

  46. 	HELLO      = CommandCode(0x1f)

  47. 	RGET       = CommandCode(0x30)

  48. 	RSET       = CommandCode(0x31)

  49. 	RSETQ      = CommandCode(0x32)

  50. 	RAPPEND    = CommandCode(0x33)

  51. 	RAPPENDQ   = CommandCode(0x34)

  52. 	RPREPEND   = CommandCode(0x35)

  53. 	RPREPENDQ  = CommandCode(0x36)

  54. 	RDELETE    = CommandCode(0x37)

  55. 	RDELETEQ   = CommandCode(0x38)

  56. 	RINCR      = CommandCode(0x39)

  57. 	RINCRQ     = CommandCode(0x3a)

  58. 	RDECR      = CommandCode(0x3b)

  59. 	RDECRQ     = CommandCode(0x3c)

  60. 

  61. 	SASL_LIST_MECHS = CommandCode(0x20)

  62. 	SASL_AUTH       = CommandCode(0x21)

  63. 	SASL_STEP       = CommandCode(0x22)

  64. 

  65. 	SET_VBUCKET = CommandCode(0x3d)

  66. 

  67. 	TAP_CONNECT          = CommandCode(0x40) // Client-sent request to initiate Tap feed

  68. 	TAP_MUTATION         = CommandCode(0x41) // Notification of a SET/ADD/REPLACE/etc. on the server

  69. 	TAP_DELETE           = CommandCode(0x42) // Notification of a DELETE on the server

  70. 	TAP_FLUSH            = CommandCode(0x43) // Replicates a flush_all command

  71. 	TAP_OPAQUE           = CommandCode(0x44) // Opaque control data from the engine

  72. 	TAP_VBUCKET_SET      = CommandCode(0x45) // Sets state of vbucket in receiver (used in takeover)

  73. 	TAP_CHECKPOINT_START = CommandCode(0x46) // Notifies start of new checkpoint

  74. 	TAP_CHECKPOINT_END   = CommandCode(0x47) // Notifies end of checkpoint

  75. 

  76. 	UPR_OPEN        = CommandCode(0x50) // Open a UPR connection with a name

  77. 	UPR_ADDSTREAM   = CommandCode(0x51) // Sent by ebucketMigrator to UPR Consumer

  78. 	UPR_CLOSESTREAM = CommandCode(0x52) // Sent by eBucketMigrator to UPR Consumer

  79. 	UPR_FAILOVERLOG = CommandCode(0x54) // Request failover logs

  80. 	UPR_STREAMREQ   = CommandCode(0x53) // Stream request from consumer to producer

  81. 	UPR_STREAMEND   = CommandCode(0x55) // Sent by producer when it has no more messages to stream

  82. 	UPR_SNAPSHOT    = CommandCode(0x56) // Start of a new snapshot

  83. 	UPR_MUTATION    = CommandCode(0x57) // Key mutation

  84. 	UPR_DELETION    = CommandCode(0x58) // Key deletion

  85. 	UPR_EXPIRATION  = CommandCode(0x59) // Key expiration

  86. 	UPR_FLUSH       = CommandCode(0x5a) // Delete all the data for a vbucket

  87. 	UPR_NOOP        = CommandCode(0x5c) // UPR NOOP

  88. 	UPR_BUFFERACK   = CommandCode(0x5d) // UPR Buffer Acknowledgement

  89. 	UPR_CONTROL     = CommandCode(0x5e) // Set flow control params

  90. 

  91. 	SELECT_BUCKET = CommandCode(0x89) // Select bucket

  92. 

  93. 	OBSERVE_SEQNO = CommandCode(0x91) // Sequence Number based Observe

  94. 	OBSERVE       = CommandCode(0x92)

  95. 

  96. 	GET_META                 = CommandCode(0xA0) // Get meta. returns with expiry, flags, cas etc

  97. 	GET_COLLECTIONS_MANIFEST = CommandCode(0xba) // Get entire collections manifest.

  98. 	COLLECTIONS_GET_CID      = CommandCode(0xbb) // Get collection id.

  99. 	SUBDOC_GET               = CommandCode(0xc5) // Get subdoc. Returns with xattrs

  100. 	SUBDOC_MULTI_LOOKUP      = CommandCode(0xd0) // Multi lookup. Doc xattrs and meta.

  101. 

  102. )

  103. 

  104. // command codes that are counted toward DCP control buffer

  105. // when DCP clients receive DCP messages with these command codes, they need to provide acknowledgement

  106. var BufferedCommandCodeMap = map[CommandCode]bool{

  107. 	SET_VBUCKET:    true,

  108. 	UPR_STREAMEND:  true,

  109. 	UPR_SNAPSHOT:   true,

  110. 	UPR_MUTATION:   true,

  111. 	UPR_DELETION:   true,

  112. 	UPR_EXPIRATION: true}

  113. 

  114. // Status field for memcached response.

  115. type Status uint16

  116. 

  117. // Matches with protocol_binary.h as source of truth

  118. const (

  119. 	SUCCESS            = Status(0x00)

  120. 	KEY_ENOENT         = Status(0x01)

  121. 	KEY_EEXISTS        = Status(0x02)

  122. 	E2BIG              = Status(0x03)

  123. 	EINVAL             = Status(0x04)

  124. 	NOT_STORED         = Status(0x05)

  125. 	DELTA_BADVAL       = Status(0x06)

  126. 	NOT_MY_VBUCKET     = Status(0x07)

  127. 	NO_BUCKET          = Status(0x08)

  128. 	LOCKED             = Status(0x09)

  129. 	AUTH_STALE         = Status(0x1f)

  130. 	AUTH_ERROR         = Status(0x20)

  131. 	AUTH_CONTINUE      = Status(0x21)

  132. 	ERANGE             = Status(0x22)

  133. 	ROLLBACK           = Status(0x23)

  134. 	EACCESS            = Status(0x24)

  135. 	NOT_INITIALIZED    = Status(0x25)

  136. 	UNKNOWN_COMMAND    = Status(0x81)

  137. 	ENOMEM             = Status(0x82)

  138. 	NOT_SUPPORTED      = Status(0x83)

  139. 	EINTERNAL          = Status(0x84)

  140. 	EBUSY              = Status(0x85)

  141. 	TMPFAIL            = Status(0x86)

  142. 	UNKNOWN_COLLECTION = Status(0x88)

  143. 

  144. 	SYNC_WRITE_IN_PROGRESS = Status(0xa2)

  145. 	SYNC_WRITE_AMBIGUOUS   = Status(0xa3)

  146. 

  147. 	// SUBDOC

  148. 	SUBDOC_PATH_NOT_FOUND             = Status(0xc0)

  149. 	SUBDOC_BAD_MULTI                  = Status(0xcc)

  150. 	SUBDOC_MULTI_PATH_FAILURE_DELETED = Status(0xd3)

  151. )

  152. 

  153. // for log redaction

  154. const (

  155. 	UdTagBegin = "<ud>"

  156. 	UdTagEnd   = "</ud>"

  157. )

  158. 

  159. var isFatal = map[Status]bool{

  160. 	DELTA_BADVAL:  true,

  161. 	NO_BUCKET:     true,

  162. 	AUTH_STALE:    true,

  163. 	AUTH_ERROR:    true,

  164. 	ERANGE:        true,

  165. 	ROLLBACK:      true,

  166. 	EACCESS:       true,

  167. 	ENOMEM:        true,

  168. 	NOT_SUPPORTED: true,

  169. }

  170. 

  171. // the producer/consumer bit in dcp flags

  172. var DCP_PRODUCER uint32 = 0x01

  173. 

  174. // the include XATTRS bit in dcp flags

  175. var DCP_OPEN_INCLUDE_XATTRS uint32 = 0x04

  176. 

  177. // the include deletion time bit in dcp flags

  178. var DCP_OPEN_INCLUDE_DELETE_TIMES uint32 = 0x20

  179. 

  180. // Datatype to Include XATTRS in SUBDOC GET

  181. var SUBDOC_FLAG_XATTR uint8 = 0x04

  182. 

  183. // MCItem is an internal representation of an item.

  184. type MCItem struct {

  185. 	Cas               uint64

  186. 	Flags, Expiration uint32

  187. 	Data              []byte

  188. }

  189. 

  190. // Number of bytes in a binary protocol header.

  191. const HDR_LEN = 24

  192. 

  193. // Mapping of CommandCode -> name of command (not exhaustive)

  194. var CommandNames map[CommandCode]string

  195. 

  196. // StatusNames human readable names for memcached response.

  197. var StatusNames map[Status]string

  198. 

  199. func init() {

  200. 	CommandNames = make(map[CommandCode]string)

  201. 	CommandNames[GET] = "GET"

  202. 	CommandNames[SET] = "SET"

  203. 	CommandNames[ADD] = "ADD"

  204. 	CommandNames[REPLACE] = "REPLACE"

  205. 	CommandNames[DELETE] = "DELETE"

  206. 	CommandNames[INCREMENT] = "INCREMENT"

  207. 	CommandNames[DECREMENT] = "DECREMENT"

  208. 	CommandNames[QUIT] = "QUIT"

  209. 	CommandNames[FLUSH] = "FLUSH"

  210. 	CommandNames[GETQ] = "GETQ"

  211. 	CommandNames[NOOP] = "NOOP"

  212. 	CommandNames[VERSION] = "VERSION"

  213. 	CommandNames[GETK] = "GETK"

  214. 	CommandNames[GETKQ] = "GETKQ"

  215. 	CommandNames[APPEND] = "APPEND"

  216. 	CommandNames[PREPEND] = "PREPEND"

  217. 	CommandNames[STAT] = "STAT"

  218. 	CommandNames[SETQ] = "SETQ"

  219. 	CommandNames[ADDQ] = "ADDQ"

  220. 	CommandNames[REPLACEQ] = "REPLACEQ"

  221. 	CommandNames[DELETEQ] = "DELETEQ"

  222. 	CommandNames[INCREMENTQ] = "INCREMENTQ"

  223. 	CommandNames[DECREMENTQ] = "DECREMENTQ"

  224. 	CommandNames[QUITQ] = "QUITQ"

  225. 	CommandNames[FLUSHQ] = "FLUSHQ"

  226. 	CommandNames[APPENDQ] = "APPENDQ"

  227. 	CommandNames[PREPENDQ] = "PREPENDQ"

  228. 	CommandNames[RGET] = "RGET"

  229. 	CommandNames[RSET] = "RSET"

  230. 	CommandNames[RSETQ] = "RSETQ"

  231. 	CommandNames[RAPPEND] = "RAPPEND"

  232. 	CommandNames[RAPPENDQ] = "RAPPENDQ"

  233. 	CommandNames[RPREPEND] = "RPREPEND"

  234. 	CommandNames[RPREPENDQ] = "RPREPENDQ"

  235. 	CommandNames[RDELETE] = "RDELETE"

  236. 	CommandNames[RDELETEQ] = "RDELETEQ"

  237. 	CommandNames[RINCR] = "RINCR"

  238. 	CommandNames[RINCRQ] = "RINCRQ"

  239. 	CommandNames[RDECR] = "RDECR"

  240. 	CommandNames[RDECRQ] = "RDECRQ"

  241. 

  242. 	CommandNames[SASL_LIST_MECHS] = "SASL_LIST_MECHS"

  243. 	CommandNames[SASL_AUTH] = "SASL_AUTH"

  244. 	CommandNames[SASL_STEP] = "SASL_STEP"

  245. 

  246. 	CommandNames[TAP_CONNECT] = "TAP_CONNECT"

  247. 	CommandNames[TAP_MUTATION] = "TAP_MUTATION"

  248. 	CommandNames[TAP_DELETE] = "TAP_DELETE"

  249. 	CommandNames[TAP_FLUSH] = "TAP_FLUSH"

  250. 	CommandNames[TAP_OPAQUE] = "TAP_OPAQUE"

  251. 	CommandNames[TAP_VBUCKET_SET] = "TAP_VBUCKET_SET"

  252. 	CommandNames[TAP_CHECKPOINT_START] = "TAP_CHECKPOINT_START"

  253. 	CommandNames[TAP_CHECKPOINT_END] = "TAP_CHECKPOINT_END"

  254. 

  255. 	CommandNames[UPR_OPEN] = "UPR_OPEN"

  256. 	CommandNames[UPR_ADDSTREAM] = "UPR_ADDSTREAM"

  257. 	CommandNames[UPR_CLOSESTREAM] = "UPR_CLOSESTREAM"

  258. 	CommandNames[UPR_FAILOVERLOG] = "UPR_FAILOVERLOG"

  259. 	CommandNames[UPR_STREAMREQ] = "UPR_STREAMREQ"

  260. 	CommandNames[UPR_STREAMEND] = "UPR_STREAMEND"

  261. 	CommandNames[UPR_SNAPSHOT] = "UPR_SNAPSHOT"

  262. 	CommandNames[UPR_MUTATION] = "UPR_MUTATION"

  263. 	CommandNames[UPR_DELETION] = "UPR_DELETION"

  264. 	CommandNames[UPR_EXPIRATION] = "UPR_EXPIRATION"

  265. 	CommandNames[UPR_FLUSH] = "UPR_FLUSH"

  266. 	CommandNames[UPR_NOOP] = "UPR_NOOP"

  267. 	CommandNames[UPR_BUFFERACK] = "UPR_BUFFERACK"

  268. 	CommandNames[UPR_CONTROL] = "UPR_CONTROL"

  269. 	CommandNames[SUBDOC_GET] = "SUBDOC_GET"

  270. 	CommandNames[SUBDOC_MULTI_LOOKUP] = "SUBDOC_MULTI_LOOKUP"

  271. 	CommandNames[GET_COLLECTIONS_MANIFEST] = "GET_COLLECTIONS_MANIFEST"

  272. 	CommandNames[COLLECTIONS_GET_CID] = "COLLECTIONS_GET_CID"

  273. 

  274. 	StatusNames = make(map[Status]string)

  275. 	StatusNames[SUCCESS] = "SUCCESS"

  276. 	StatusNames[KEY_ENOENT] = "KEY_ENOENT"

  277. 	StatusNames[KEY_EEXISTS] = "KEY_EEXISTS"

  278. 	StatusNames[E2BIG] = "E2BIG"

  279. 	StatusNames[EINVAL] = "EINVAL"

  280. 	StatusNames[NOT_STORED] = "NOT_STORED"

  281. 	StatusNames[DELTA_BADVAL] = "DELTA_BADVAL"

  282. 	StatusNames[NOT_MY_VBUCKET] = "NOT_MY_VBUCKET"

  283. 	StatusNames[NO_BUCKET] = "NO_BUCKET"

  284. 	StatusNames[AUTH_STALE] = "AUTH_STALE"

  285. 	StatusNames[AUTH_ERROR] = "AUTH_ERROR"

  286. 	StatusNames[AUTH_CONTINUE] = "AUTH_CONTINUE"

  287. 	StatusNames[ERANGE] = "ERANGE"

  288. 	StatusNames[ROLLBACK] = "ROLLBACK"

  289. 	StatusNames[EACCESS] = "EACCESS"

  290. 	StatusNames[NOT_INITIALIZED] = "NOT_INITIALIZED"

  291. 	StatusNames[UNKNOWN_COMMAND] = "UNKNOWN_COMMAND"

  292. 	StatusNames[ENOMEM] = "ENOMEM"

  293. 	StatusNames[NOT_SUPPORTED] = "NOT_SUPPORTED"

  294. 	StatusNames[EINTERNAL] = "EINTERNAL"

  295. 	StatusNames[EBUSY] = "EBUSY"

  296. 	StatusNames[TMPFAIL] = "TMPFAIL"

  297. 	StatusNames[UNKNOWN_COLLECTION] = "UNKNOWN_COLLECTION"

  298. 	StatusNames[SUBDOC_PATH_NOT_FOUND] = "SUBDOC_PATH_NOT_FOUND"

  299. 	StatusNames[SUBDOC_BAD_MULTI] = "SUBDOC_BAD_MULTI"

  300. 

  301. }

  302. 

  303. // String an op code.

  304. func (o CommandCode) String() (rv string) {

  305. 	rv = CommandNames[o]

  306. 	if rv == "" {

  307. 		rv = fmt.Sprintf("0x%02x", int(o))

  308. 	}

  309. 	return rv

  310. }

  311. 

  312. // String an op code.

  313. func (s Status) String() (rv string) {

  314. 	rv = StatusNames[s]

  315. 	if rv == "" {

  316. 		rv = fmt.Sprintf("0x%02x", int(s))

  317. 	}

  318. 	return rv

  319. }

  320. 

  321. // IsQuiet will return true if a command is a "quiet" command.

  322. func (o CommandCode) IsQuiet() bool {

  323. 	switch o {

  324. 	case GETQ,

  325. 		GETKQ,

  326. 		SETQ,

  327. 		ADDQ,

  328. 		REPLACEQ,

  329. 		DELETEQ,

  330. 		INCREMENTQ,

  331. 		DECREMENTQ,

  332. 		QUITQ,

  333. 		FLUSHQ,

  334. 		APPENDQ,

  335. 		PREPENDQ,

  336. 		RSETQ,

  337. 		RAPPENDQ,

  338. 		RPREPENDQ,

  339. 		RDELETEQ,

  340. 		RINCRQ,

  341. 		RDECRQ:

  342. 		return true

  343. 	}

  344. 	return false

  345. }
上海开阖软件有限公司 沪ICP备12045867号-1