2 * Summary: interface for memcached server
3 * Description: main include file for libmemcached
5 * Copy: See Copyright for the status of this software.
10 #ifndef __MEMCACHED_H__
11 #define __MEMCACHED_H__
15 #include <sys/types.h>
16 #include <netinet/in.h>
22 typedef struct memcached_st memcached_st
;
23 typedef struct memcached_stat_st memcached_stat_st
;
24 typedef struct memcached_result_st memcached_result_st
;
25 typedef struct memcached_string_st memcached_string_st
;
26 typedef struct memcached_server_st memcached_server_st
;
28 #define MEMCACHED_VERSION_STRING 12
29 #define MEMCACHED_DEFAULT_PORT 11211
30 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
31 #define SMALL_STRING_LEN 1024
32 #define HUGE_STRING_LEN 8196
33 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
34 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
35 #define MEMCACHED_MAX_HOST_LENGTH 64
36 #define MEMCACHED_WHEEL_SIZE 1024
37 #define MEMCACHED_STRIDE 4
42 MEMCACHED_HOST_LOOKUP_FAILURE
,
43 MEMCACHED_CONNECTION_FAILURE
,
44 MEMCACHED_CONNECTION_BIND_FAILURE
,
45 MEMCACHED_WRITE_FAILURE
,
46 MEMCACHED_READ_FAILURE
,
47 MEMCACHED_UNKNOWN_READ_FAILURE
,
48 MEMCACHED_PROTOCOL_ERROR
,
49 MEMCACHED_CLIENT_ERROR
,
50 MEMCACHED_SERVER_ERROR
,
51 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
52 MEMCACHED_DATA_EXISTS
,
53 MEMCACHED_DATA_DOES_NOT_EXIST
,
57 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
58 MEMCACHED_PARTIAL_READ
,
59 MEMCACHED_SOME_ERRORS
,
66 MEMCACHED_FAIL_UNIX_SOCKET
,
67 MEMCACHED_NOT_SUPPORTED
,
68 MEMCACHED_NO_KEY_PROVIDED
,
69 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
73 MEMCACHED_DISTRIBUTION_MODULO
,
74 MEMCACHED_DISTRIBUTION_CONSISTENT
,
75 } memcached_server_distribution
;
78 MEMCACHED_BEHAVIOR_NO_BLOCK
,
79 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
80 MEMCACHED_BEHAVIOR_HASH
,
81 MEMCACHED_BEHAVIOR_KETAMA
,
82 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
83 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
84 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
85 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
86 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
87 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
91 MEMCACHED_HASH_DEFAULT
= 0,
94 MEMCACHED_HASH_FNV1_64
,
95 MEMCACHED_HASH_FNV1A_64
,
96 MEMCACHED_HASH_FNV1_32
,
97 MEMCACHED_HASH_FNV1A_32
,
98 MEMCACHED_HASH_KETAMA
,
103 MEMCACHED_CONNECTION_UNKNOWN
,
104 MEMCACHED_CONNECTION_TCP
,
105 MEMCACHED_CONNECTION_UDP
,
106 MEMCACHED_CONNECTION_UNIX_SOCKET
,
107 } memcached_connection
;
110 MEMCACHED_NOT_ALLOCATED
,
113 } memcached_allocated
;
115 struct memcached_server_st
{
116 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
119 unsigned int stack_responses
;
120 unsigned int cursor_active
;
121 char write_buffer
[MEMCACHED_MAX_BUFFER
];
122 size_t write_buffer_offset
;
124 char read_buffer
[MEMCACHED_MAX_BUFFER
];
125 size_t read_buffer_length
;
127 memcached_allocated sockaddr_inited
;
128 struct addrinfo
*address_info
;
129 memcached_connection type
;
130 uint8_t major_version
;
131 uint8_t minor_version
;
132 uint8_t micro_version
;
136 struct memcached_stat_st
{
141 uint32_t pointer_size
;
142 uint32_t rusage_user_seconds
;
143 uint32_t rusage_user_microseconds
;
144 uint32_t rusage_system_seconds
;
145 uint32_t rusage_system_microseconds
;
147 uint32_t total_items
;
148 uint32_t limit_maxbytes
;
149 uint32_t curr_connections
;
150 uint32_t total_connections
;
151 uint32_t connection_structures
;
159 uint64_t bytes_written
;
160 char version
[MEMCACHED_VERSION_STRING
];
163 struct memcached_string_st
{
165 memcached_allocated is_allocated
;
172 struct memcached_result_st
{
173 memcached_allocated is_allocated
;
175 char key
[MEMCACHED_MAX_KEY
];
177 memcached_string_st value
;
182 struct memcached_st
{
183 memcached_allocated is_allocated
;
184 memcached_server_st
*hosts
;
185 unsigned int number_of_hosts
;
186 unsigned int cursor_server
;
189 unsigned long long flags
;
192 int32_t poll_timeout
;
193 memcached_string_st result_buffer
;
195 memcached_server_distribution distribution
;
196 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
198 memcached_return warning
; /* Future Use */
202 memcached_st
*memcached_create(memcached_st
*ptr
);
203 void memcached_free(memcached_st
*ptr
);
204 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
206 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
208 memcached_return
memcached_increment(memcached_st
*ptr
,
209 char *key
, size_t key_length
,
212 memcached_return
memcached_decrement(memcached_st
*ptr
,
213 char *key
, size_t key_length
,
216 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
217 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
218 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
219 char *hostname
, unsigned int port
);
220 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
221 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
222 void memcached_quit(memcached_st
*ptr
);
223 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
224 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
225 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
227 /* All of the functions for adding data to the server */
228 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
229 char *value
, size_t value_length
,
232 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
233 char *value
, size_t value_length
,
236 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
237 char *value
, size_t value_length
,
240 memcached_return
memcached_append(memcached_st
*ptr
,
241 char *key
, size_t key_length
,
242 char *value
, size_t value_length
,
245 memcached_return
memcached_prepend(memcached_st
*ptr
,
246 char *key
, size_t key_length
,
247 char *value
, size_t value_length
,
250 memcached_return
memcached_cas(memcached_st
*ptr
,
251 char *key
, size_t key_length
,
252 char *value
, size_t value_length
,
258 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
259 size_t *value_length
,
261 memcached_return
*error
);
262 memcached_return
memcached_mget(memcached_st
*ptr
,
263 char **keys
, size_t *key_length
,
264 unsigned int number_of_keys
);
265 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
266 size_t *value_length
, uint16_t *flags
,
267 memcached_return
*error
);
268 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
269 memcached_result_st
*result
,
270 memcached_return
*error
);
272 /* Server Public functions */
273 #define memcached_server_count(A) (A)->number_of_hosts
274 #define memcached_server_name(A,B) (B).hostname
275 #define memcached_server_port(A,B) (B).port
276 #define memcached_server_list(A) (A)->hosts
277 #define memcached_server_response_count(A,B) (A)->hosts[B].stack_responses
279 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
282 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
284 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
286 void memcached_server_list_free(memcached_server_st
*ptr
);
287 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
289 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
290 char *hostname
, unsigned int port
,
291 memcached_return
*error
);
292 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
293 memcached_server_st
*memcached_servers_parse(char *server_strings
);
295 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
296 char *key
, memcached_return
*error
);
297 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
298 memcached_return
*error
);
301 void memcached_result_free(memcached_result_st
*result
);
302 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
303 memcached_result_st
*result
);
304 #define memcached_result_key_value(A) A->key
305 #define memcached_result_key_length(A) A->key_length
307 #define memcached_result_value(A) memcached_string_value(A->value)
308 #define memcached_result_length(A) memcached_string_length(A->value)
310 char *memcached_result_value(memcached_result_st
*ptr
);
311 size_t memcached_result_length(memcached_result_st
*ptr
);
313 #define memcached_result_flags(A) A->flags
314 #define memcached_result_cas(A) A->cas
317 #ifndef __WATCHPOINT_H__
318 #define __WATCHPOINT_H__
319 /* Some personal debugging functions */
321 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
322 #ifdef __MEMCACHED_H__
323 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
325 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
326 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
327 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
328 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
329 #define WATCHPOINT_ASSERT(A) assert((A));
332 #define WATCHPOINT { 1; };
333 #define WATCHPOINT_ERROR(A) { 1; };
334 #define WATCHPOINT_STRING(A) { 1; };
335 #define WATCHPOINT_STRING_LENGTH(A,B) { 1; };
336 #define WATCHPOINT_NUMBER(A) { 1; };
337 #define WATCHPOINT_ERRNO(A) { 1; };
338 #define WATCHPOINT_ASSERT(A) { 1; };
341 #ifdef __MEMCACHED_H__
342 #define WATCHPOINT_ERROR(A)
344 #define WATCHPOINT_STRING(A)
345 #define WATCHPOINT_NUMBER(A)
346 #define WATCHPOINT_ERRNO(A)
347 #define WATCHPOINT_ASSERT(A)
350 #endif /* __WATCHPOINT_H__ */
357 #endif /* __MEMCACHED_H__ */