2 * Copyright (c) <2008>, Sun Microsystems, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY SUN MICROSYSTEMS, INC. ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL SUN MICROSYSTEMS, INC. BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Summary: Constants used by to implement the binary protocol.
30 * Copy: See Copyright for the status of this software.
32 * Author: Trond Norbye <trond.norbye@sun.com>
35 #ifndef PROTOCOL_BINARY_H
36 #define PROTOCOL_BINARY_H
41 * This file contains definitions of the constants and packet formats
42 * defined in the binary specification. Please note that you _MUST_ remember
43 * to convert each multibyte field to / from network byte order to / from
52 * Definition of the legal "magic" values used in a packet.
53 * See section 3.1 Magic byte
56 PROTOCOL_BINARY_REQ
= 0x80,
57 PROTOCOL_BINARY_RES
= 0x81
58 } protocol_binary_magic
;
61 * Definition of the valid response status numbers.
62 * See section 3.2 Response Status
65 PROTOCOL_BINARY_RESPONSE_SUCCESS
= 0x00,
66 PROTOCOL_BINARY_RESPONSE_KEY_ENOENT
= 0x01,
67 PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS
= 0x02,
68 PROTOCOL_BINARY_RESPONSE_E2BIG
= 0x03,
69 PROTOCOL_BINARY_RESPONSE_EINVAL
= 0x04,
70 PROTOCOL_BINARY_RESPONSE_NOT_STORED
= 0x05,
71 PROTOCOL_BINARY_RESPONSE_DELTA_BADVAL
= 0x06,
72 PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND
= 0x81,
73 PROTOCOL_BINARY_RESPONSE_ENOMEM
= 0x82,
74 PROTOCOL_BINARY_RESPONSE_EIO
= 0xff
75 } protocol_binary_response_status
;
78 * Defintion of the different command opcodes.
79 * See section 3.3 Command Opcodes
82 PROTOCOL_BINARY_CMD_GET
= 0x00,
83 PROTOCOL_BINARY_CMD_SET
= 0x01,
84 PROTOCOL_BINARY_CMD_ADD
= 0x02,
85 PROTOCOL_BINARY_CMD_REPLACE
= 0x03,
86 PROTOCOL_BINARY_CMD_DELETE
= 0x04,
87 PROTOCOL_BINARY_CMD_INCREMENT
= 0x05,
88 PROTOCOL_BINARY_CMD_DECREMENT
= 0x06,
89 PROTOCOL_BINARY_CMD_QUIT
= 0x07,
90 PROTOCOL_BINARY_CMD_FLUSH
= 0x08,
91 PROTOCOL_BINARY_CMD_GETQ
= 0x09,
92 PROTOCOL_BINARY_CMD_NOOP
= 0x0a,
93 PROTOCOL_BINARY_CMD_VERSION
= 0x0b,
94 PROTOCOL_BINARY_CMD_GETK
= 0x0c,
95 PROTOCOL_BINARY_CMD_GETKQ
= 0x0d,
96 PROTOCOL_BINARY_CMD_APPEND
= 0x0e,
97 PROTOCOL_BINARY_CMD_PREPEND
= 0x0f,
98 PROTOCOL_BINARY_CMD_STAT
= 0x10,
99 PROTOCOL_BINARY_CMD_SETQ
= 0x11,
100 PROTOCOL_BINARY_CMD_ADDQ
= 0x12,
101 PROTOCOL_BINARY_CMD_REPLACEQ
= 0x13,
102 PROTOCOL_BINARY_CMD_DELETEQ
= 0x14,
103 PROTOCOL_BINARY_CMD_INCREMENTQ
= 0x15,
104 PROTOCOL_BINARY_CMD_DECREMENTQ
= 0x16,
105 PROTOCOL_BINARY_CMD_QUITQ
= 0x17,
106 PROTOCOL_BINARY_CMD_FLUSHQ
= 0x18,
107 PROTOCOL_BINARY_CMD_APPENDQ
= 0x19,
108 PROTOCOL_BINARY_CMD_PREPENDQ
= 0x1a,
110 /* These commands are used for range operations and exist within
111 * this header for use in other projects. Range operations are
112 * not expected to be implemented in the memcached server itself.
114 PROTOCOL_BINARY_CMD_RGET
= 0x30,
115 PROTOCOL_BINARY_CMD_RSET
= 0x31,
116 PROTOCOL_BINARY_CMD_RSETQ
= 0x32,
117 PROTOCOL_BINARY_CMD_RAPPEND
= 0x33,
118 PROTOCOL_BINARY_CMD_RAPPENDQ
= 0x34,
119 PROTOCOL_BINARY_CMD_RPREPEND
= 0x35,
120 PROTOCOL_BINARY_CMD_RPREPENDQ
= 0x36,
121 PROTOCOL_BINARY_CMD_RDELETE
= 0x37,
122 PROTOCOL_BINARY_CMD_RDELETEQ
= 0x38,
123 PROTOCOL_BINARY_CMD_RINCR
= 0x39,
124 PROTOCOL_BINARY_CMD_RINCRQ
= 0x3a,
125 PROTOCOL_BINARY_CMD_RDECR
= 0x3b,
126 PROTOCOL_BINARY_CMD_RDECRQ
= 0x3c
127 /* End Range operations */
129 } protocol_binary_command
;
132 * Definition of the data types in the packet
133 * See section 3.4 Data Types
136 PROTOCOL_BINARY_RAW_BYTES
= 0x00
137 } protocol_binary_datatypes
;
140 * Definition of the header structure for a request packet.
156 } protocol_binary_request_header
;
159 * Definition of the header structure for a response packet.
175 } protocol_binary_response_header
;
178 * Definition of a request-packet containing no extras
182 protocol_binary_request_header header
;
184 uint8_t bytes
[sizeof(protocol_binary_request_header
)];
185 } protocol_binary_request_no_extras
;
188 * Definition of a response-packet containing no extras
192 protocol_binary_response_header header
;
194 uint8_t bytes
[sizeof(protocol_binary_response_header
)];
195 } protocol_binary_response_no_extras
;
198 * Definition of the packet used by the get, getq, getk and getkq command.
201 typedef protocol_binary_request_no_extras protocol_binary_request_get
;
202 typedef protocol_binary_request_no_extras protocol_binary_request_getq
;
203 typedef protocol_binary_request_no_extras protocol_binary_request_getk
;
204 typedef protocol_binary_request_no_extras protocol_binary_request_getkq
;
207 * Definition of the packet returned from a successful get, getq, getk and
213 protocol_binary_response_header header
;
218 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 4];
219 } protocol_binary_response_get
;
221 typedef protocol_binary_response_get protocol_binary_response_getq
;
222 typedef protocol_binary_response_get protocol_binary_response_getk
;
223 typedef protocol_binary_response_get protocol_binary_response_getkq
;
226 * Definition of the packet used by the delete command
229 typedef protocol_binary_request_no_extras protocol_binary_request_delete
;
232 * Definition of the packet returned by the delete command
235 typedef protocol_binary_response_no_extras protocol_binary_response_delete
;
238 * Definition of the packet used by the flush command
240 * Please note that the expiration field is optional, so remember to see
241 * check the header.bodysize to see if it is present.
245 protocol_binary_request_header header
;
250 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
251 } protocol_binary_request_flush
;
254 * Definition of the packet returned by the flush command
257 typedef protocol_binary_response_no_extras protocol_binary_response_flush
;
260 * Definition of the packet used by set, add and replace
265 protocol_binary_request_header header
;
271 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 8];
272 } protocol_binary_request_set
;
273 typedef protocol_binary_request_set protocol_binary_request_add
;
274 typedef protocol_binary_request_set protocol_binary_request_replace
;
277 * Definition of the packet returned by set, add and replace
280 typedef protocol_binary_response_no_extras protocol_binary_response_set
;
281 typedef protocol_binary_response_no_extras protocol_binary_response_add
;
282 typedef protocol_binary_response_no_extras protocol_binary_response_replace
;
285 * Definition of the noop packet
288 typedef protocol_binary_request_no_extras protocol_binary_request_noop
;
291 * Definition of the packet returned by the noop command
294 typedef protocol_binary_response_no_extras protocol_binary_response_noop
;
297 * Definition of the structure used by the increment and decrement
303 protocol_binary_request_header header
;
310 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 20];
311 } protocol_binary_request_incr
;
312 typedef protocol_binary_request_incr protocol_binary_request_decr
;
315 * Definition of the response from an incr or decr command
321 protocol_binary_response_header header
;
326 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 8];
327 } protocol_binary_response_incr
;
328 typedef protocol_binary_response_incr protocol_binary_response_decr
;
331 * Definition of the quit
334 typedef protocol_binary_request_no_extras protocol_binary_request_quit
;
337 * Definition of the packet returned by the quit command
340 typedef protocol_binary_response_no_extras protocol_binary_response_quit
;
343 * Definition of the packet used by append and prepend command
346 typedef protocol_binary_request_no_extras protocol_binary_request_append
;
347 typedef protocol_binary_request_no_extras protocol_binary_request_prepend
;
350 * Definition of the packet returned from a successful append or prepend
353 typedef protocol_binary_response_no_extras protocol_binary_response_append
;
354 typedef protocol_binary_response_no_extras protocol_binary_response_prepend
;
357 * Definition of the packet used by the version command
360 typedef protocol_binary_request_no_extras protocol_binary_request_version
;
363 * Definition of the packet returned from a successful version command
366 typedef protocol_binary_response_no_extras protocol_binary_response_version
;
370 * Definition of the packet used by the stats command.
373 typedef protocol_binary_request_no_extras protocol_binary_request_stats
;
376 * Definition of the packet returned from a successful stats command
379 typedef protocol_binary_response_no_extras protocol_binary_response_stats
;
382 * Definition of a request for a range operation.
383 * See http://code.google.com/p/memcached/wiki/RangeOps
385 * These types are used for range operations and exist within
386 * this header for use in other projects. Range operations are
387 * not expected to be implemented in the memcached server itself.
391 protocol_binary_response_header header
;
396 uint32_t max_results
;
399 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
400 } protocol_binary_request_rangeop
;
402 typedef protocol_binary_request_rangeop protocol_binary_request_rget
;
403 typedef protocol_binary_request_rangeop protocol_binary_request_rset
;
404 typedef protocol_binary_request_rangeop protocol_binary_request_rsetq
;
405 typedef protocol_binary_request_rangeop protocol_binary_request_rappend
;
406 typedef protocol_binary_request_rangeop protocol_binary_request_rappendq
;
407 typedef protocol_binary_request_rangeop protocol_binary_request_rprepend
;
408 typedef protocol_binary_request_rangeop protocol_binary_request_rprependq
;
409 typedef protocol_binary_request_rangeop protocol_binary_request_rdelete
;
410 typedef protocol_binary_request_rangeop protocol_binary_request_rdeleteq
;
411 typedef protocol_binary_request_rangeop protocol_binary_request_rincr
;
412 typedef protocol_binary_request_rangeop protocol_binary_request_rincrq
;
413 typedef protocol_binary_request_rangeop protocol_binary_request_rdecr
;
414 typedef protocol_binary_request_rangeop protocol_binary_request_rdecrq
;
419 #endif /* PROTOCOL_BINARY_H */