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_status
;
77 * Defintion of the different command opcodes.
78 * See section 3.3 Command Opcodes
81 PROTOCOL_BINARY_CMD_GET
= 0x00,
82 PROTOCOL_BINARY_CMD_SET
= 0x01,
83 PROTOCOL_BINARY_CMD_ADD
= 0x02,
84 PROTOCOL_BINARY_CMD_REPLACE
= 0x03,
85 PROTOCOL_BINARY_CMD_DELETE
= 0x04,
86 PROTOCOL_BINARY_CMD_INCREMENT
= 0x05,
87 PROTOCOL_BINARY_CMD_DECREMENT
= 0x06,
88 PROTOCOL_BINARY_CMD_QUIT
= 0x07,
89 PROTOCOL_BINARY_CMD_FLUSH
= 0x08,
90 PROTOCOL_BINARY_CMD_GETQ
= 0x09,
91 PROTOCOL_BINARY_CMD_NOOP
= 0x0a,
92 PROTOCOL_BINARY_CMD_VERSION
= 0x0b,
93 PROTOCOL_BINARY_CMD_GETK
= 0x0c,
94 PROTOCOL_BINARY_CMD_GETKQ
= 0x0d,
95 PROTOCOL_BINARY_CMD_APPEND
= 0x0e,
96 PROTOCOL_BINARY_CMD_PREPEND
= 0x0f,
97 PROTOCOL_BINARY_CMD_STAT
= 0x10,
98 PROTOCOL_BINARY_CMD_SETQ
= 0x11,
99 PROTOCOL_BINARY_CMD_ADDQ
= 0x12,
100 PROTOCOL_BINARY_CMD_REPLACEQ
= 0x13,
101 PROTOCOL_BINARY_CMD_DELETEQ
= 0x14,
102 PROTOCOL_BINARY_CMD_INCREMENTQ
= 0x15,
103 PROTOCOL_BINARY_CMD_DECREMENTQ
= 0x16,
104 PROTOCOL_BINARY_CMD_QUITQ
= 0x17,
105 PROTOCOL_BINARY_CMD_FLUSHQ
= 0x18,
106 PROTOCOL_BINARY_CMD_APPENDQ
= 0x19,
107 PROTOCOL_BINARY_CMD_PREPENDQ
= 0x1a,
109 /* These commands are used for range operations and exist within
110 * this header for use in other projects. Range operations are
111 * not expected to be implemented in the memcached server itself.
113 PROTOCOL_BINARY_CMD_RGET
= 0x30,
114 PROTOCOL_BINARY_CMD_RSET
= 0x31,
115 PROTOCOL_BINARY_CMD_RSETQ
= 0x32,
116 PROTOCOL_BINARY_CMD_RAPPEND
= 0x33,
117 PROTOCOL_BINARY_CMD_RAPPENDQ
= 0x34,
118 PROTOCOL_BINARY_CMD_RPREPEND
= 0x35,
119 PROTOCOL_BINARY_CMD_RPREPENDQ
= 0x36,
120 PROTOCOL_BINARY_CMD_RDELETE
= 0x37,
121 PROTOCOL_BINARY_CMD_RDELETEQ
= 0x38,
122 PROTOCOL_BINARY_CMD_RINCR
= 0x39,
123 PROTOCOL_BINARY_CMD_RINCRQ
= 0x3a,
124 PROTOCOL_BINARY_CMD_RDECR
= 0x3b,
125 PROTOCOL_BINARY_CMD_RDECRQ
= 0x3c
126 /* End Range operations */
128 } protocol_binary_command
;
131 * Definition of the data types in the packet
132 * See section 3.4 Data Types
135 PROTOCOL_BINARY_RAW_BYTES
= 0x00
136 } protocol_binary_datatypes
;
139 * Definition of the header structure for a request packet.
155 } protocol_binary_request_header
;
158 * Definition of the header structure for a response packet.
174 } protocol_binary_response_header
;
177 * Definition of a request-packet containing no extras
181 protocol_binary_request_header header
;
183 uint8_t bytes
[sizeof(protocol_binary_request_header
)];
184 } protocol_binary_request_no_extras
;
187 * Definition of a response-packet containing no extras
191 protocol_binary_response_header header
;
193 uint8_t bytes
[sizeof(protocol_binary_response_header
)];
194 } protocol_binary_response_no_extras
;
197 * Definition of the packet used by the get, getq, getk and getkq command.
200 typedef protocol_binary_request_no_extras protocol_binary_request_get
;
201 typedef protocol_binary_request_no_extras protocol_binary_request_getq
;
202 typedef protocol_binary_request_no_extras protocol_binary_request_getk
;
203 typedef protocol_binary_request_no_extras protocol_binary_request_getkq
;
206 * Definition of the packet returned from a successful get, getq, getk and
212 protocol_binary_response_header header
;
217 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 4];
218 } protocol_binary_response_get
;
220 typedef protocol_binary_response_get protocol_binary_response_getq
;
221 typedef protocol_binary_response_get protocol_binary_response_getk
;
222 typedef protocol_binary_response_get protocol_binary_response_getkq
;
225 * Definition of the packet used by the delete command
228 typedef protocol_binary_request_no_extras protocol_binary_request_delete
;
231 * Definition of the packet returned by the delete command
234 typedef protocol_binary_response_no_extras protocol_binary_response_delete
;
237 * Definition of the packet used by the flush command
239 * Please note that the expiration field is optional, so remember to see
240 * check the header.bodysize to see if it is present.
244 protocol_binary_request_header header
;
249 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
250 } protocol_binary_request_flush
;
253 * Definition of the packet returned by the flush command
256 typedef protocol_binary_response_no_extras protocol_binary_response_flush
;
259 * Definition of the packet used by set, add and replace
264 protocol_binary_request_header header
;
270 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 8];
271 } protocol_binary_request_set
;
272 typedef protocol_binary_request_set protocol_binary_request_add
;
273 typedef protocol_binary_request_set protocol_binary_request_replace
;
276 * Definition of the packet returned by set, add and replace
279 typedef protocol_binary_response_no_extras protocol_binary_response_set
;
280 typedef protocol_binary_response_no_extras protocol_binary_response_add
;
281 typedef protocol_binary_response_no_extras protocol_binary_response_replace
;
284 * Definition of the noop packet
287 typedef protocol_binary_request_no_extras protocol_binary_request_noop
;
290 * Definition of the packet returned by the noop command
293 typedef protocol_binary_response_no_extras protocol_binary_response_noop
;
296 * Definition of the structure used by the increment and decrement
302 protocol_binary_request_header header
;
309 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 20];
310 } protocol_binary_request_incr
;
311 typedef protocol_binary_request_incr protocol_binary_request_decr
;
314 * Definition of the response from an incr or decr command
320 protocol_binary_response_header header
;
325 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 8];
326 } protocol_binary_response_incr
;
327 typedef protocol_binary_response_incr protocol_binary_response_decr
;
330 * Definition of the quit
333 typedef protocol_binary_request_no_extras protocol_binary_request_quit
;
336 * Definition of the packet returned by the quit command
339 typedef protocol_binary_response_no_extras protocol_binary_response_quit
;
342 * Definition of the packet used by append and prepend command
345 typedef protocol_binary_request_no_extras protocol_binary_request_append
;
346 typedef protocol_binary_request_no_extras protocol_binary_request_prepend
;
349 * Definition of the packet returned from a successful append or prepend
352 typedef protocol_binary_response_no_extras protocol_binary_response_append
;
353 typedef protocol_binary_response_no_extras protocol_binary_response_prepend
;
356 * Definition of the packet used by the version command
359 typedef protocol_binary_request_no_extras protocol_binary_request_version
;
362 * Definition of the packet returned from a successful version command
365 typedef protocol_binary_response_no_extras protocol_binary_response_version
;
369 * Definition of the packet used by the stats command.
372 typedef protocol_binary_request_no_extras protocol_binary_request_stats
;
375 * Definition of the packet returned from a successful stats command
378 typedef protocol_binary_response_no_extras protocol_binary_response_stats
;
381 * Definition of a request for a range operation.
382 * See http://code.google.com/p/memcached/wiki/RangeOps
384 * These types are used for range operations and exist within
385 * this header for use in other projects. Range operations are
386 * not expected to be implemented in the memcached server itself.
390 protocol_binary_response_header header
;
395 uint32_t max_results
;
398 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
399 } protocol_binary_request_rangeop
;
401 typedef protocol_binary_request_rangeop protocol_binary_request_rget
;
402 typedef protocol_binary_request_rangeop protocol_binary_request_rset
;
403 typedef protocol_binary_request_rangeop protocol_binary_request_rsetq
;
404 typedef protocol_binary_request_rangeop protocol_binary_request_rappend
;
405 typedef protocol_binary_request_rangeop protocol_binary_request_rappendq
;
406 typedef protocol_binary_request_rangeop protocol_binary_request_rprepend
;
407 typedef protocol_binary_request_rangeop protocol_binary_request_rprependq
;
408 typedef protocol_binary_request_rangeop protocol_binary_request_rdelete
;
409 typedef protocol_binary_request_rangeop protocol_binary_request_rdeleteq
;
410 typedef protocol_binary_request_rangeop protocol_binary_request_rincr
;
411 typedef protocol_binary_request_rangeop protocol_binary_request_rincrq
;
412 typedef protocol_binary_request_rangeop protocol_binary_request_rdecr
;
413 typedef protocol_binary_request_rangeop protocol_binary_request_rdecrq
;
418 #endif /* PROTOCOL_BINARY_H */