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_MAX_REPLICAS 4
33 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
36 #define LIBMEMCACHED_VERSION_STRING "0.17"
41 MEMCACHED_HOST_LOOKUP_FAILURE
,
42 MEMCACHED_CONNECTION_FAILURE
,
43 MEMCACHED_CONNECTION_BIND_FAILURE
,
44 MEMCACHED_WRITE_FAILURE
,
45 MEMCACHED_READ_FAILURE
,
46 MEMCACHED_UNKNOWN_READ_FAILURE
,
47 MEMCACHED_PROTOCOL_ERROR
,
48 MEMCACHED_CLIENT_ERROR
,
49 MEMCACHED_SERVER_ERROR
,
50 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
51 MEMCACHED_DATA_EXISTS
,
52 MEMCACHED_DATA_DOES_NOT_EXIST
,
56 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
57 MEMCACHED_PARTIAL_READ
,
58 MEMCACHED_SOME_ERRORS
,
65 MEMCACHED_FAIL_UNIX_SOCKET
,
66 MEMCACHED_NOT_SUPPORTED
,
67 MEMCACHED_NO_KEY_PROVIDED
,
68 MEMCACHED_FETCH_NOTFINISHED
,
71 MEMCACHED_BAD_KEY_PROVIDED
,
72 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
75 typedef struct memcached_st memcached_st
;
76 typedef struct memcached_stat_st memcached_stat_st
;
77 typedef struct memcached_result_st memcached_result_st
;
78 typedef struct memcached_string_st memcached_string_st
;
79 typedef struct memcached_server_st memcached_server_st
;
80 typedef memcached_return (*memcached_clone_func
)(memcached_st
*parent
, memcached_st
*clone
);
81 typedef memcached_return (*memcached_cleanup_func
)(memcached_st
*ptr
);
82 typedef void (*memcached_free_function
)(memcached_st
*ptr
, void *mem
);
83 typedef void *(*memcached_malloc_function
)(memcached_st
*ptr
, const size_t size
);
84 typedef void *(*memcached_realloc_function
)(memcached_st
*ptr
, void *mem
, const size_t size
);
85 typedef memcached_return (*memcached_execute_function
)(memcached_st
*ptr
, memcached_result_st
*result
, void *context
);
86 typedef memcached_return (*memcached_server_function
)(memcached_st
*ptr
, memcached_server_st
*server
, void *context
);
89 MEMCACHED_DISTRIBUTION_MODULA
,
90 MEMCACHED_DISTRIBUTION_CONSISTENT
,
91 } memcached_server_distribution
;
94 MEMCACHED_BEHAVIOR_NO_BLOCK
,
95 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
96 MEMCACHED_BEHAVIOR_HASH
,
97 MEMCACHED_BEHAVIOR_KETAMA
,
98 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
99 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
100 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
101 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
102 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
103 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
104 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
105 MEMCACHED_BEHAVIOR_SORT_HOSTS
,
106 MEMCACHED_BEHAVIOR_VERIFY_KEY
,
107 MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
,
108 MEMCACHED_BEHAVIOR_REPLICAS
,
109 } memcached_behavior
;
112 MEMCACHED_CALLBACK_USER_DATA
,
113 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
114 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
115 MEMCACHED_CALLBACK_MALLOC_FUNCTION
,
116 MEMCACHED_CALLBACK_REALLOC_FUNCTION
,
117 MEMCACHED_CALLBACK_FREE_FUNCTION
,
118 } memcached_callback
;
121 MEMCACHED_HASH_DEFAULT
= 0,
124 MEMCACHED_HASH_FNV1_64
,
125 MEMCACHED_HASH_FNV1A_64
,
126 MEMCACHED_HASH_FNV1_32
,
127 MEMCACHED_HASH_FNV1A_32
,
128 MEMCACHED_HASH_KETAMA
,
129 MEMCACHED_HASH_HSIEH
,
133 MEMCACHED_CONNECTION_UNKNOWN
,
134 MEMCACHED_CONNECTION_TCP
,
135 MEMCACHED_CONNECTION_UDP
,
136 MEMCACHED_CONNECTION_UNIX_SOCKET
,
137 } memcached_connection
;
140 MEMCACHED_NOT_ALLOCATED
,
143 } memcached_allocated
;
145 struct memcached_server_st
{
146 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
150 unsigned int cursor_active
;
151 char write_buffer
[MEMCACHED_MAX_BUFFER
];
152 size_t write_buffer_offset
;
153 char read_buffer
[MEMCACHED_MAX_BUFFER
];
154 size_t read_data_length
;
155 size_t read_buffer_length
;
157 memcached_allocated sockaddr_inited
;
158 struct addrinfo
*address_info
;
159 memcached_connection type
;
160 uint8_t major_version
;
161 uint8_t minor_version
;
162 uint8_t micro_version
;
167 struct memcached_stat_st
{
172 uint32_t pointer_size
;
173 uint32_t rusage_user_seconds
;
174 uint32_t rusage_user_microseconds
;
175 uint32_t rusage_system_seconds
;
176 uint32_t rusage_system_microseconds
;
178 uint32_t total_items
;
179 uint64_t limit_maxbytes
;
180 uint32_t curr_connections
;
181 uint32_t total_connections
;
182 uint32_t connection_structures
;
190 uint64_t bytes_written
;
191 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
194 struct memcached_string_st
{
196 memcached_allocated is_allocated
;
203 struct memcached_result_st
{
204 memcached_allocated is_allocated
;
206 char key
[MEMCACHED_MAX_KEY
];
208 memcached_string_st value
;
211 /* Add result callback function */
214 struct memcached_st
{
215 memcached_allocated is_allocated
;
216 memcached_server_st
*hosts
;
217 unsigned int number_of_hosts
;
218 unsigned int cursor_server
;
223 int32_t poll_timeout
;
224 int32_t connect_timeout
;
225 memcached_result_st result
;
227 memcached_server_distribution distribution
;
229 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
230 memcached_clone_func on_clone
;
231 memcached_cleanup_func on_cleanup
;
232 memcached_free_function call_free
;
233 memcached_malloc_function call_malloc
;
234 memcached_realloc_function call_realloc
;
235 uint8_t number_of_replicas
;
236 #ifdef NOT_USED /* Future Use */
237 memcached_return warning
;
242 const char * memcached_lib_version(void);
244 memcached_st
*memcached_create(memcached_st
*ptr
);
245 void memcached_free(memcached_st
*ptr
);
246 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
248 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
250 memcached_return
memcached_increment(memcached_st
*ptr
,
251 char *key
, size_t key_length
,
254 memcached_return
memcached_decrement(memcached_st
*ptr
,
255 char *key
, size_t key_length
,
258 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
259 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
260 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
261 char *hostname
, unsigned int port
);
262 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
263 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
264 void memcached_quit(memcached_st
*ptr
);
265 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
266 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
267 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
269 /* All of the functions for adding data to the server */
270 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
271 char *value
, size_t value_length
,
274 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
275 char *value
, size_t value_length
,
278 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
279 char *value
, size_t value_length
,
282 memcached_return
memcached_append(memcached_st
*ptr
,
283 char *key
, size_t key_length
,
284 char *value
, size_t value_length
,
287 memcached_return
memcached_prepend(memcached_st
*ptr
,
288 char *key
, size_t key_length
,
289 char *value
, size_t value_length
,
292 memcached_return
memcached_cas(memcached_st
*ptr
,
293 char *key
, size_t key_length
,
294 char *value
, size_t value_length
,
300 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
301 size_t *value_length
,
303 memcached_return
*error
);
304 memcached_return
memcached_mget(memcached_st
*ptr
,
305 char **keys
, size_t *key_length
,
306 unsigned int number_of_keys
);
307 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
308 size_t *value_length
, uint32_t *flags
,
309 memcached_return
*error
);
310 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
311 memcached_result_st
*result
,
312 memcached_return
*error
);
314 /* Server Public functions */
315 #define memcached_server_count(A) (A)->number_of_hosts
316 #define memcached_server_name(A,B) (B).hostname
317 #define memcached_server_port(A,B) (B).port
318 #define memcached_server_list(A) (A)->hosts
319 #define memcached_server_response_count(A) (A)->cursor_active
322 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
325 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
327 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
329 void memcached_server_list_free(memcached_server_st
*ptr
);
330 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
332 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
333 char *hostname
, unsigned int port
,
334 memcached_return
*error
);
335 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
336 memcached_server_st
*memcached_servers_parse(char *server_strings
);
338 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
339 char *key
, memcached_return
*error
);
340 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
341 memcached_return
*error
);
343 char *memcached_get_by_key(memcached_st
*ptr
,
344 char *master_key
, size_t master_key_length
,
345 char *key
, size_t key_length
,
346 size_t *value_length
,
348 memcached_return
*error
);
350 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
351 char *master_key
, size_t master_key_length
,
352 char **keys
, size_t *key_length
,
353 unsigned int number_of_keys
);
355 memcached_return
memcached_set_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_add_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_replace_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_prepend_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_append_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_cas_by_key(memcached_st
*ptr
,
391 char *master_key
, size_t master_key_length
,
392 char *key
, size_t key_length
,
393 char *value
, size_t value_length
,
397 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
398 char *master_key
, size_t master_key_length
,
399 char *key
, size_t key_length
,
402 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
403 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
405 unsigned int number_of_callbacks
408 memcached_return
memcached_callback_set(memcached_st
*ptr
,
409 memcached_callback flag
,
411 void *memcached_callback_get(memcached_st
*ptr
,
412 memcached_callback flag
,
413 memcached_return
*error
);
415 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
416 memcached_server_function
*callback
,
418 unsigned int number_of_callbacks
);
421 void memcached_result_free(memcached_result_st
*result
);
422 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
423 memcached_result_st
*result
);
424 #define memcached_result_key_value(A) (A)->key
425 #define memcached_result_key_length(A) (A)->key_length
427 #define memcached_result_value(A) memcached_string_value((A)->value)
428 #define memcached_result_length(A) memcached_string_length((A)->value)
430 char *memcached_result_value(memcached_result_st
*ptr
);
431 size_t memcached_result_length(memcached_result_st
*ptr
);
433 #define memcached_result_flags(A) (A)->flags
434 #define memcached_result_cas(A) (A)->cas
437 #ifndef __WATCHPOINT_H__
438 #define __WATCHPOINT_H__
439 /* Some personal debugging functions */
441 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
442 #ifdef __MEMCACHED_H__
443 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
444 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
446 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
447 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
448 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
449 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
450 #define WATCHPOINT_ASSERT(A) assert((A));
453 #ifdef __MEMCACHED_H__
454 #define WATCHPOINT_ERROR(A)
455 #define WATCHPOINT_IFERROR(A)
457 #define WATCHPOINT_STRING(A)
458 #define WATCHPOINT_NUMBER(A)
459 #define WATCHPOINT_ERRNO(A)
460 #define WATCHPOINT_ASSERT(A)
463 #endif /* __WATCHPOINT_H__ */
470 #endif /* __MEMCACHED_H__ */