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
38 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
43 MEMCACHED_HOST_LOOKUP_FAILURE
,
44 MEMCACHED_CONNECTION_FAILURE
,
45 MEMCACHED_CONNECTION_BIND_FAILURE
,
46 MEMCACHED_WRITE_FAILURE
,
47 MEMCACHED_READ_FAILURE
,
48 MEMCACHED_UNKNOWN_READ_FAILURE
,
49 MEMCACHED_PROTOCOL_ERROR
,
50 MEMCACHED_CLIENT_ERROR
,
51 MEMCACHED_SERVER_ERROR
,
52 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
53 MEMCACHED_DATA_EXISTS
,
54 MEMCACHED_DATA_DOES_NOT_EXIST
,
58 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
59 MEMCACHED_PARTIAL_READ
,
60 MEMCACHED_SOME_ERRORS
,
67 MEMCACHED_FAIL_UNIX_SOCKET
,
68 MEMCACHED_NOT_SUPPORTED
,
69 MEMCACHED_NO_KEY_PROVIDED
,
70 MEMCACHED_FETCH_NOTFINISHED
,
73 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
77 MEMCACHED_DISTRIBUTION_MODULA
,
78 MEMCACHED_DISTRIBUTION_CONSISTENT
,
79 } memcached_server_distribution
;
82 MEMCACHED_BEHAVIOR_NO_BLOCK
,
83 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
84 MEMCACHED_BEHAVIOR_HASH
,
85 MEMCACHED_BEHAVIOR_KETAMA
,
86 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
87 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
88 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
89 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
90 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
91 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
92 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
96 MEMCACHED_HASH_DEFAULT
= 0,
99 MEMCACHED_HASH_FNV1_64
,
100 MEMCACHED_HASH_FNV1A_64
,
101 MEMCACHED_HASH_FNV1_32
,
102 MEMCACHED_HASH_FNV1A_32
,
103 MEMCACHED_HASH_KETAMA
,
104 MEMCACHED_HASH_HSIEH
,
108 MEMCACHED_CONNECTION_UNKNOWN
,
109 MEMCACHED_CONNECTION_TCP
,
110 MEMCACHED_CONNECTION_UDP
,
111 MEMCACHED_CONNECTION_UNIX_SOCKET
,
112 } memcached_connection
;
115 MEMCACHED_NOT_ALLOCATED
,
118 } memcached_allocated
;
120 struct memcached_server_st
{
121 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
124 unsigned int cursor_active
;
125 char write_buffer
[MEMCACHED_MAX_BUFFER
];
126 size_t write_buffer_offset
;
128 char read_buffer
[MEMCACHED_MAX_BUFFER
];
129 size_t read_data_length
;
130 size_t read_buffer_length
;
132 memcached_allocated sockaddr_inited
;
133 struct addrinfo
*address_info
;
134 memcached_connection type
;
135 uint8_t major_version
;
136 uint8_t minor_version
;
137 uint8_t micro_version
;
141 struct memcached_stat_st
{
146 uint32_t pointer_size
;
147 uint32_t rusage_user_seconds
;
148 uint32_t rusage_user_microseconds
;
149 uint32_t rusage_system_seconds
;
150 uint32_t rusage_system_microseconds
;
152 uint32_t total_items
;
153 uint32_t limit_maxbytes
;
154 uint32_t curr_connections
;
155 uint32_t total_connections
;
156 uint32_t connection_structures
;
164 uint64_t bytes_written
;
165 char version
[MEMCACHED_VERSION_STRING
];
168 struct memcached_string_st
{
170 memcached_allocated is_allocated
;
177 struct memcached_result_st
{
178 memcached_allocated is_allocated
;
180 char key
[MEMCACHED_MAX_KEY
];
182 memcached_string_st value
;
185 /* Add result callback function */
188 struct memcached_st
{
189 memcached_allocated is_allocated
;
190 memcached_server_st
*hosts
;
191 unsigned int number_of_hosts
;
192 unsigned int cursor_server
;
195 unsigned long long flags
;
198 int32_t poll_timeout
;
199 memcached_result_st result
;
201 memcached_server_distribution distribution
;
202 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
203 #ifdef NOT_USED /* Future Use */
205 memcached_return warning
;
210 memcached_st
*memcached_create(memcached_st
*ptr
);
211 void memcached_free(memcached_st
*ptr
);
212 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
214 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
216 memcached_return
memcached_increment(memcached_st
*ptr
,
217 char *key
, size_t key_length
,
220 memcached_return
memcached_decrement(memcached_st
*ptr
,
221 char *key
, size_t key_length
,
224 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
225 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
226 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
227 char *hostname
, unsigned int port
);
228 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
229 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
230 void memcached_quit(memcached_st
*ptr
);
231 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
232 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
233 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
235 /* All of the functions for adding data to the server */
236 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
237 char *value
, size_t value_length
,
240 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
241 char *value
, size_t value_length
,
244 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
245 char *value
, size_t value_length
,
248 memcached_return
memcached_append(memcached_st
*ptr
,
249 char *key
, size_t key_length
,
250 char *value
, size_t value_length
,
253 memcached_return
memcached_prepend(memcached_st
*ptr
,
254 char *key
, size_t key_length
,
255 char *value
, size_t value_length
,
258 memcached_return
memcached_cas(memcached_st
*ptr
,
259 char *key
, size_t key_length
,
260 char *value
, size_t value_length
,
266 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
267 size_t *value_length
,
269 memcached_return
*error
);
270 memcached_return
memcached_mget(memcached_st
*ptr
,
271 char **keys
, size_t *key_length
,
272 unsigned int number_of_keys
);
273 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
274 size_t *value_length
, uint32_t *flags
,
275 memcached_return
*error
);
276 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
277 memcached_result_st
*result
,
278 memcached_return
*error
);
280 /* Server Public functions */
281 #define memcached_server_count(A) (A)->number_of_hosts
282 #define memcached_server_name(A,B) (B).hostname
283 #define memcached_server_port(A,B) (B).port
284 #define memcached_server_list(A) (A)->hosts
285 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
287 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
290 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
292 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
294 void memcached_server_list_free(memcached_server_st
*ptr
);
295 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
297 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
298 char *hostname
, unsigned int port
,
299 memcached_return
*error
);
300 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
301 memcached_server_st
*memcached_servers_parse(char *server_strings
);
303 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
304 char *key
, memcached_return
*error
);
305 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
306 memcached_return
*error
);
308 char *memcached_get_by_key(memcached_st
*ptr
,
309 char *master_key
, size_t master_key_length
,
310 char *key
, size_t key_length
,
311 size_t *value_length
,
313 memcached_return
*error
);
315 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
316 char *master_key
, size_t master_key_length
,
317 char **keys
, size_t *key_length
,
318 unsigned int number_of_keys
);
320 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
321 char *master_key
, size_t master_key_length
,
322 char *key
, size_t key_length
,
323 char *value
, size_t value_length
,
327 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
328 char *master_key
, size_t master_key_length
,
329 char *key
, size_t key_length
,
330 char *value
, size_t value_length
,
334 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
335 char *master_key
, size_t master_key_length
,
336 char *key
, size_t key_length
,
337 char *value
, size_t value_length
,
341 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
342 char *master_key
, size_t master_key_length
,
343 char *key
, size_t key_length
,
344 char *value
, size_t value_length
,
348 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
349 char *master_key
, size_t master_key_length
,
350 char *key
, size_t key_length
,
351 char *value
, size_t value_length
,
355 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
356 char *master_key
, size_t master_key_length
,
357 char *key
, size_t key_length
,
358 char *value
, size_t value_length
,
362 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
363 char *master_key
, size_t master_key_length
,
364 char *key
, size_t key_length
,
367 memcached_return
memcached_mdelete(memcached_st
*ptr
,
368 char **key
, size_t *key_length
,
369 unsigned int number_of_keys
,
372 memcached_return
memcached_mdelete_by_key(memcached_st
*ptr
,
373 char *master_key
, size_t master_key_length
,
374 char **key
, size_t *key_length
,
375 unsigned int number_of_keys
,
378 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
379 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
381 unsigned int number_of_callbacks
385 void memcached_result_free(memcached_result_st
*result
);
386 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
387 memcached_result_st
*result
);
388 #define memcached_result_key_value(A) (A)->key
389 #define memcached_result_key_length(A) (A)->key_length
391 #define memcached_result_value(A) memcached_string_value((A)->value)
392 #define memcached_result_length(A) memcached_string_length((A)->value)
394 char *memcached_result_value(memcached_result_st
*ptr
);
395 size_t memcached_result_length(memcached_result_st
*ptr
);
397 #define memcached_result_flags(A) (A)->flags
398 #define memcached_result_cas(A) (A)->cas
401 #ifndef __WATCHPOINT_H__
402 #define __WATCHPOINT_H__
403 /* Some personal debugging functions */
405 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
406 #ifdef __MEMCACHED_H__
407 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
408 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
410 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
411 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
412 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
413 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
414 #define WATCHPOINT_ASSERT(A) assert((A));
417 #ifdef __MEMCACHED_H__
418 #define WATCHPOINT_ERROR(A)
419 #define WATCHPOINT_IFERROR(A)
421 #define WATCHPOINT_STRING(A)
422 #define WATCHPOINT_NUMBER(A)
423 #define WATCHPOINT_ERRNO(A)
424 #define WATCHPOINT_ASSERT(A)
427 #endif /* __WATCHPOINT_H__ */
434 #endif /* __MEMCACHED_H__ */