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 /* These are Private and should not be used by applications */
23 #define MEMCACHED_VERSION_STRING_LENGTH 12
26 #define MEMCACHED_DEFAULT_PORT 11211
27 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
28 #define MEMCACHED_MAX_BUFFER 8196
29 #define MEMCACHED_MAX_HOST_LENGTH 64
30 #define MEMCACHED_WHEEL_SIZE 1024
31 #define MEMCACHED_STRIDE 4
32 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
35 #define LIBMEMCACHED_VERSION_STRING "0.16"
40 MEMCACHED_HOST_LOOKUP_FAILURE
,
41 MEMCACHED_CONNECTION_FAILURE
,
42 MEMCACHED_CONNECTION_BIND_FAILURE
,
43 MEMCACHED_WRITE_FAILURE
,
44 MEMCACHED_READ_FAILURE
,
45 MEMCACHED_UNKNOWN_READ_FAILURE
,
46 MEMCACHED_PROTOCOL_ERROR
,
47 MEMCACHED_CLIENT_ERROR
,
48 MEMCACHED_SERVER_ERROR
,
49 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
50 MEMCACHED_DATA_EXISTS
,
51 MEMCACHED_DATA_DOES_NOT_EXIST
,
55 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
56 MEMCACHED_PARTIAL_READ
,
57 MEMCACHED_SOME_ERRORS
,
64 MEMCACHED_FAIL_UNIX_SOCKET
,
65 MEMCACHED_NOT_SUPPORTED
,
66 MEMCACHED_NO_KEY_PROVIDED
,
67 MEMCACHED_FETCH_NOTFINISHED
,
70 MEMCACHED_BAD_KEY_PROVIDED
,
71 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
74 typedef struct memcached_st memcached_st
;
75 typedef struct memcached_stat_st memcached_stat_st
;
76 typedef struct memcached_result_st memcached_result_st
;
77 typedef struct memcached_string_st memcached_string_st
;
78 typedef struct memcached_server_st memcached_server_st
;
79 typedef memcached_return (*memcached_clone_func
)(memcached_st
*parent
, memcached_st
*clone
);
80 typedef memcached_return (*memcached_cleanup_func
)(memcached_st
*ptr
);
81 typedef void (*memcached_free_function
)(memcached_st
*ptr
, void *mem
);
82 typedef void *(*memcached_malloc_function
)(memcached_st
*ptr
, const size_t size
);
83 typedef void *(*memcached_realloc_function
)(memcached_st
*ptr
, void *mem
, const size_t size
);
86 MEMCACHED_DISTRIBUTION_MODULA
,
87 MEMCACHED_DISTRIBUTION_CONSISTENT
,
88 } memcached_server_distribution
;
91 MEMCACHED_BEHAVIOR_NO_BLOCK
,
92 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
93 MEMCACHED_BEHAVIOR_HASH
,
94 MEMCACHED_BEHAVIOR_KETAMA
,
95 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
96 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
97 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
98 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
99 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
100 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
101 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
102 MEMCACHED_BEHAVIOR_USER_DATA
,
103 } memcached_behavior
;
106 MEMCACHED_CALLBACK_USER_DATA
,
107 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
108 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
109 MEMCACHED_CALLBACK_MALLOC_FUNCTION
,
110 MEMCACHED_CALLBACK_REALLOC_FUNCTION
,
111 MEMCACHED_CALLBACK_FREE_FUNCTION
,
112 } memcached_callback
;
115 MEMCACHED_HASH_DEFAULT
= 0,
118 MEMCACHED_HASH_FNV1_64
,
119 MEMCACHED_HASH_FNV1A_64
,
120 MEMCACHED_HASH_FNV1_32
,
121 MEMCACHED_HASH_FNV1A_32
,
122 MEMCACHED_HASH_KETAMA
,
123 MEMCACHED_HASH_HSIEH
,
127 MEMCACHED_CONNECTION_UNKNOWN
,
128 MEMCACHED_CONNECTION_TCP
,
129 MEMCACHED_CONNECTION_UDP
,
130 MEMCACHED_CONNECTION_UNIX_SOCKET
,
131 } memcached_connection
;
134 MEMCACHED_NOT_ALLOCATED
,
137 } memcached_allocated
;
139 struct memcached_server_st
{
140 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
144 unsigned int cursor_active
;
145 char write_buffer
[MEMCACHED_MAX_BUFFER
];
146 size_t write_buffer_offset
;
147 char read_buffer
[MEMCACHED_MAX_BUFFER
];
148 size_t read_data_length
;
149 size_t read_buffer_length
;
151 memcached_allocated sockaddr_inited
;
152 struct addrinfo
*address_info
;
153 memcached_connection type
;
154 uint8_t major_version
;
155 uint8_t minor_version
;
156 uint8_t micro_version
;
161 struct memcached_stat_st
{
166 uint32_t pointer_size
;
167 uint32_t rusage_user_seconds
;
168 uint32_t rusage_user_microseconds
;
169 uint32_t rusage_system_seconds
;
170 uint32_t rusage_system_microseconds
;
172 uint32_t total_items
;
173 uint64_t limit_maxbytes
;
174 uint32_t curr_connections
;
175 uint32_t total_connections
;
176 uint32_t connection_structures
;
184 uint64_t bytes_written
;
185 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
188 struct memcached_string_st
{
190 memcached_allocated is_allocated
;
197 struct memcached_result_st
{
198 memcached_allocated is_allocated
;
200 char key
[MEMCACHED_MAX_KEY
];
202 memcached_string_st value
;
205 /* Add result callback function */
208 struct memcached_st
{
209 memcached_allocated is_allocated
;
210 memcached_server_st
*hosts
;
211 unsigned int number_of_hosts
;
212 unsigned int cursor_server
;
217 int32_t poll_timeout
;
218 memcached_result_st result
;
220 memcached_server_distribution distribution
;
222 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
223 memcached_clone_func on_clone
;
224 memcached_cleanup_func on_cleanup
;
225 memcached_free_function call_free
;
226 memcached_malloc_function call_malloc
;
227 memcached_realloc_function call_realloc
;
228 #ifdef NOT_USED /* Future Use */
230 memcached_return warning
;
235 const char * memcached_lib_version(void);
237 memcached_st
*memcached_create(memcached_st
*ptr
);
238 void memcached_free(memcached_st
*ptr
);
239 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
241 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
243 memcached_return
memcached_increment(memcached_st
*ptr
,
244 char *key
, size_t key_length
,
247 memcached_return
memcached_decrement(memcached_st
*ptr
,
248 char *key
, size_t key_length
,
251 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
252 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
253 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
254 char *hostname
, unsigned int port
);
255 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
256 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
257 void memcached_quit(memcached_st
*ptr
);
258 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
259 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
260 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
262 /* All of the functions for adding data to the server */
263 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
264 char *value
, size_t value_length
,
267 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
268 char *value
, size_t value_length
,
271 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
272 char *value
, size_t value_length
,
275 memcached_return
memcached_append(memcached_st
*ptr
,
276 char *key
, size_t key_length
,
277 char *value
, size_t value_length
,
280 memcached_return
memcached_prepend(memcached_st
*ptr
,
281 char *key
, size_t key_length
,
282 char *value
, size_t value_length
,
285 memcached_return
memcached_cas(memcached_st
*ptr
,
286 char *key
, size_t key_length
,
287 char *value
, size_t value_length
,
293 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
294 size_t *value_length
,
296 memcached_return
*error
);
297 memcached_return
memcached_mget(memcached_st
*ptr
,
298 char **keys
, size_t *key_length
,
299 unsigned int number_of_keys
);
300 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
301 size_t *value_length
, uint32_t *flags
,
302 memcached_return
*error
);
303 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
304 memcached_result_st
*result
,
305 memcached_return
*error
);
307 /* Server Public functions */
308 #define memcached_server_count(A) (A)->number_of_hosts
309 #define memcached_server_name(A,B) (B).hostname
310 #define memcached_server_port(A,B) (B).port
311 #define memcached_server_list(A) (A)->hosts
312 #define memcached_server_response_count(A) (A)->cursor_active
315 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
318 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
320 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
322 void memcached_server_list_free(memcached_server_st
*ptr
);
323 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
325 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
326 char *hostname
, unsigned int port
,
327 memcached_return
*error
);
328 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
329 memcached_server_st
*memcached_servers_parse(char *server_strings
);
331 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
332 char *key
, memcached_return
*error
);
333 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
334 memcached_return
*error
);
336 char *memcached_get_by_key(memcached_st
*ptr
,
337 char *master_key
, size_t master_key_length
,
338 char *key
, size_t key_length
,
339 size_t *value_length
,
341 memcached_return
*error
);
343 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
344 char *master_key
, size_t master_key_length
,
345 char **keys
, size_t *key_length
,
346 unsigned int number_of_keys
);
348 memcached_return
memcached_set_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_add_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_replace_by_key(memcached_st
*ptr
,
363 char *master_key
, size_t master_key_length
,
364 char *key
, size_t key_length
,
365 char *value
, size_t value_length
,
369 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
370 char *master_key
, size_t master_key_length
,
371 char *key
, size_t key_length
,
372 char *value
, size_t value_length
,
376 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
377 char *master_key
, size_t master_key_length
,
378 char *key
, size_t key_length
,
379 char *value
, size_t value_length
,
383 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
384 char *master_key
, size_t master_key_length
,
385 char *key
, size_t key_length
,
386 char *value
, size_t value_length
,
390 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
391 char *master_key
, size_t master_key_length
,
392 char *key
, size_t key_length
,
395 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
396 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
398 unsigned int number_of_callbacks
401 memcached_return
memcached_callback_set(memcached_st
*ptr
,
402 memcached_callback flag
,
404 void *memcached_callback_get(memcached_st
*ptr
,
405 memcached_callback flag
,
406 memcached_return
*error
);
409 void memcached_result_free(memcached_result_st
*result
);
410 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
411 memcached_result_st
*result
);
412 #define memcached_result_key_value(A) (A)->key
413 #define memcached_result_key_length(A) (A)->key_length
415 #define memcached_result_value(A) memcached_string_value((A)->value)
416 #define memcached_result_length(A) memcached_string_length((A)->value)
418 char *memcached_result_value(memcached_result_st
*ptr
);
419 size_t memcached_result_length(memcached_result_st
*ptr
);
421 #define memcached_result_flags(A) (A)->flags
422 #define memcached_result_cas(A) (A)->cas
425 #ifndef __WATCHPOINT_H__
426 #define __WATCHPOINT_H__
427 /* Some personal debugging functions */
429 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
430 #ifdef __MEMCACHED_H__
431 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
432 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
434 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
435 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
436 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
437 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
438 #define WATCHPOINT_ASSERT(A) assert((A));
441 #ifdef __MEMCACHED_H__
442 #define WATCHPOINT_ERROR(A)
443 #define WATCHPOINT_IFERROR(A)
445 #define WATCHPOINT_STRING(A)
446 #define WATCHPOINT_NUMBER(A)
447 #define WATCHPOINT_ERRNO(A)
448 #define WATCHPOINT_ASSERT(A)
451 #endif /* __WATCHPOINT_H__ */
458 #endif /* __MEMCACHED_H__ */