Work inspired by matt knox
[m6w6/libmemcached] / libmemcached / memcached_constants.h
1 /*
2 * Summary: Constants for libmemcached
3 *
4 * Copy: See Copyright for the status of this software.
5 *
6 * Author: Brian Aker
7 */
8
9 #ifndef __MEMCACHED_CONSTANTS_H__
10 #define __MEMCACHED_CONSTANTS_H__
11
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15
16 /* Public defines */
17 #define MEMCACHED_DEFAULT_PORT 11211
18 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
19 #define MEMCACHED_MAX_BUFFER 8196
20 #define MEMCACHED_MAX_HOST_LENGTH 64
21 #define MEMCACHED_MAX_HOST_SORT_LENGTH 86 /* Used for Ketama */
22 #define MEMCACHED_POINTS_PER_SERVER 100
23 #define MEMCACHED_POINTS_PER_SERVER_KETAMA 160
24 #define MEMCACHED_CONTINUUM_SIZE MEMCACHED_POINTS_PER_SERVER*100 /* This would then set max hosts to 100 */
25 #define MEMCACHED_STRIDE 4
26 #define MEMCACHED_DEFAULT_TIMEOUT 1000
27 #define MEMCACHED_CONTINUUM_ADDITION 10 /* How many extra slots we should build for in the continuum */
28 #define MEMCACHED_PREFIX_KEY_MAX_SIZE 128
29 #define MEMCACHED_EXPIRATION_NOT_ADD 0xffffffffU
30
31 typedef enum {
32 MEMCACHED_SUCCESS,
33 MEMCACHED_FAILURE,
34 MEMCACHED_HOST_LOOKUP_FAILURE,
35 MEMCACHED_CONNECTION_FAILURE,
36 MEMCACHED_CONNECTION_BIND_FAILURE,
37 MEMCACHED_WRITE_FAILURE,
38 MEMCACHED_READ_FAILURE,
39 MEMCACHED_UNKNOWN_READ_FAILURE,
40 MEMCACHED_PROTOCOL_ERROR,
41 MEMCACHED_CLIENT_ERROR,
42 MEMCACHED_SERVER_ERROR,
43 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
44 MEMCACHED_DATA_EXISTS,
45 MEMCACHED_DATA_DOES_NOT_EXIST,
46 MEMCACHED_NOTSTORED,
47 MEMCACHED_STORED,
48 MEMCACHED_NOTFOUND,
49 MEMCACHED_MEMORY_ALLOCATION_FAILURE,
50 MEMCACHED_PARTIAL_READ,
51 MEMCACHED_SOME_ERRORS,
52 MEMCACHED_NO_SERVERS,
53 MEMCACHED_END,
54 MEMCACHED_DELETED,
55 MEMCACHED_VALUE,
56 MEMCACHED_STAT,
57 MEMCACHED_ITEM,
58 MEMCACHED_ERRNO,
59 MEMCACHED_FAIL_UNIX_SOCKET,
60 MEMCACHED_NOT_SUPPORTED,
61 MEMCACHED_NO_KEY_PROVIDED, /* Deprecated. Use MEMCACHED_BAD_KEY_PROVIDED! */
62 MEMCACHED_FETCH_NOTFINISHED,
63 MEMCACHED_TIMEOUT,
64 MEMCACHED_BUFFERED,
65 MEMCACHED_BAD_KEY_PROVIDED,
66 MEMCACHED_INVALID_HOST_PROTOCOL,
67 MEMCACHED_SERVER_MARKED_DEAD,
68 MEMCACHED_UNKNOWN_STAT_KEY,
69 MEMCACHED_MAXIMUM_RETURN /* Always add new error code before */
70 } memcached_return;
71
72 typedef enum {
73 MEMCACHED_DISTRIBUTION_MODULA,
74 MEMCACHED_DISTRIBUTION_CONSISTENT,
75 MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA,
76 MEMCACHED_DISTRIBUTION_RANDOM
77 } memcached_server_distribution;
78
79 typedef enum {
80 MEMCACHED_BEHAVIOR_NO_BLOCK,
81 MEMCACHED_BEHAVIOR_TCP_NODELAY,
82 MEMCACHED_BEHAVIOR_HASH,
83 MEMCACHED_BEHAVIOR_KETAMA,
84 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
85 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
86 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS,
87 MEMCACHED_BEHAVIOR_SUPPORT_CAS,
88 MEMCACHED_BEHAVIOR_POLL_TIMEOUT,
89 MEMCACHED_BEHAVIOR_DISTRIBUTION,
90 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS,
91 MEMCACHED_BEHAVIOR_USER_DATA,
92 MEMCACHED_BEHAVIOR_SORT_HOSTS,
93 MEMCACHED_BEHAVIOR_VERIFY_KEY,
94 MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT,
95 MEMCACHED_BEHAVIOR_RETRY_TIMEOUT,
96 MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED,
97 MEMCACHED_BEHAVIOR_KETAMA_HASH,
98 MEMCACHED_BEHAVIOR_BINARY_PROTOCOL,
99 MEMCACHED_BEHAVIOR_SND_TIMEOUT,
100 MEMCACHED_BEHAVIOR_RCV_TIMEOUT,
101 MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT,
102 MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK,
103 MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK,
104 MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH,
105 MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY,
106 MEMCACHED_BEHAVIOR_NOREPLY,
107 MEMCACHED_BEHAVIOR_USE_UDP,
108 MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS,
109 MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
110 } memcached_behavior;
111
112 typedef enum {
113 MEMCACHED_CALLBACK_PREFIX_KEY = 0,
114 MEMCACHED_CALLBACK_USER_DATA = 1,
115 MEMCACHED_CALLBACK_CLEANUP_FUNCTION = 2,
116 MEMCACHED_CALLBACK_CLONE_FUNCTION = 3,
117 #ifdef MEMCACHED_ENABLE_DEPRECATED
118 MEMCACHED_CALLBACK_MALLOC_FUNCTION = 4,
119 MEMCACHED_CALLBACK_REALLOC_FUNCTION = 5,
120 MEMCACHED_CALLBACK_FREE_FUNCTION = 6,
121 #endif
122 MEMCACHED_CALLBACK_GET_FAILURE = 7,
123 MEMCACHED_CALLBACK_DELETE_TRIGGER = 8
124 } memcached_callback;
125
126 typedef enum {
127 MEMCACHED_HASH_DEFAULT= 0,
128 MEMCACHED_HASH_MD5,
129 MEMCACHED_HASH_CRC,
130 MEMCACHED_HASH_FNV1_64,
131 MEMCACHED_HASH_FNV1A_64,
132 MEMCACHED_HASH_FNV1_32,
133 MEMCACHED_HASH_FNV1A_32,
134 MEMCACHED_HASH_HSIEH,
135 MEMCACHED_HASH_MURMUR,
136 MEMCACHED_HASH_JENKINS
137 } memcached_hash;
138
139 typedef enum {
140 MEMCACHED_CONNECTION_UNKNOWN,
141 MEMCACHED_CONNECTION_TCP,
142 MEMCACHED_CONNECTION_UDP,
143 MEMCACHED_CONNECTION_UNIX_SOCKET
144 } memcached_connection;
145
146 #ifdef __cplusplus
147 }
148 #endif
149
150 #endif /* __MEMCACHED_CONSTANTS_H__ */