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.17"
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
);
84 typedef memcached_return (*memcached_execute_function
)(memcached_st
*ptr
, memcached_result_st
*result
, void *context
);
85 typedef memcached_return (*memcached_server_function
)(memcached_st
*ptr
, memcached_server_st
*server
, void *context
);
88 MEMCACHED_DISTRIBUTION_MODULA
,
89 MEMCACHED_DISTRIBUTION_CONSISTENT
,
90 } memcached_server_distribution
;
93 MEMCACHED_BEHAVIOR_NO_BLOCK
,
94 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
95 MEMCACHED_BEHAVIOR_HASH
,
96 MEMCACHED_BEHAVIOR_KETAMA
,
97 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
98 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
99 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
100 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
101 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
102 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
103 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
104 MEMCACHED_BEHAVIOR_USER_DATA
,
105 MEMCACHED_BEHAVIOR_SORT_HOSTS
,
106 MEMCACHED_BEHAVIOR_VERIFY_KEY
,
107 MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
,
108 MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
,
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
,
130 MEMCACHED_HASH_MURMUR
,
134 MEMCACHED_CONNECTION_UNKNOWN
,
135 MEMCACHED_CONNECTION_TCP
,
136 MEMCACHED_CONNECTION_UDP
,
137 MEMCACHED_CONNECTION_UNIX_SOCKET
,
138 } memcached_connection
;
141 MEMCACHED_NOT_ALLOCATED
,
144 } memcached_allocated
;
146 struct memcached_server_st
{
147 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
151 unsigned int cursor_active
;
152 char write_buffer
[MEMCACHED_MAX_BUFFER
];
153 size_t write_buffer_offset
;
154 char read_buffer
[MEMCACHED_MAX_BUFFER
];
155 size_t read_data_length
;
156 size_t read_buffer_length
;
158 memcached_allocated sockaddr_inited
;
159 struct addrinfo
*address_info
;
160 memcached_connection type
;
161 uint8_t major_version
;
162 uint8_t minor_version
;
163 uint8_t micro_version
;
169 struct memcached_stat_st
{
174 uint32_t pointer_size
;
175 uint32_t rusage_user_seconds
;
176 uint32_t rusage_user_microseconds
;
177 uint32_t rusage_system_seconds
;
178 uint32_t rusage_system_microseconds
;
180 uint32_t total_items
;
181 uint64_t limit_maxbytes
;
182 uint32_t curr_connections
;
183 uint32_t total_connections
;
184 uint32_t connection_structures
;
192 uint64_t bytes_written
;
193 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
196 struct memcached_string_st
{
198 memcached_allocated is_allocated
;
205 struct memcached_result_st
{
206 memcached_allocated is_allocated
;
208 char key
[MEMCACHED_MAX_KEY
];
210 memcached_string_st value
;
213 /* Add result callback function */
216 struct memcached_st
{
217 memcached_allocated is_allocated
;
218 memcached_server_st
*hosts
;
219 unsigned int number_of_hosts
;
220 unsigned int cursor_server
;
225 int32_t poll_timeout
;
226 int32_t connect_timeout
;
227 int32_t retry_timeout
;
228 memcached_result_st result
;
230 memcached_server_distribution distribution
;
232 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
233 memcached_clone_func on_clone
;
234 memcached_cleanup_func on_cleanup
;
235 memcached_free_function call_free
;
236 memcached_malloc_function call_malloc
;
237 memcached_realloc_function call_realloc
;
238 #ifdef NOT_USED /* Future Use */
240 memcached_return warning
;
245 const char * memcached_lib_version(void);
247 memcached_st
*memcached_create(memcached_st
*ptr
);
248 void memcached_free(memcached_st
*ptr
);
249 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
251 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
253 memcached_return
memcached_increment(memcached_st
*ptr
,
254 char *key
, size_t key_length
,
257 memcached_return
memcached_decrement(memcached_st
*ptr
,
258 char *key
, size_t key_length
,
261 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
262 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
263 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
264 char *hostname
, unsigned int port
);
265 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
266 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
267 void memcached_quit(memcached_st
*ptr
);
268 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
269 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
270 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
272 /* All of the functions for adding data to the server */
273 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
274 char *value
, size_t value_length
,
277 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
278 char *value
, size_t value_length
,
281 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
282 char *value
, size_t value_length
,
285 memcached_return
memcached_append(memcached_st
*ptr
,
286 char *key
, size_t key_length
,
287 char *value
, size_t value_length
,
290 memcached_return
memcached_prepend(memcached_st
*ptr
,
291 char *key
, size_t key_length
,
292 char *value
, size_t value_length
,
295 memcached_return
memcached_cas(memcached_st
*ptr
,
296 char *key
, size_t key_length
,
297 char *value
, size_t value_length
,
303 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
304 size_t *value_length
,
306 memcached_return
*error
);
307 memcached_return
memcached_mget(memcached_st
*ptr
,
308 char **keys
, size_t *key_length
,
309 unsigned int number_of_keys
);
310 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
311 size_t *value_length
, uint32_t *flags
,
312 memcached_return
*error
);
313 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
314 memcached_result_st
*result
,
315 memcached_return
*error
);
317 /* Server Public functions */
318 #define memcached_server_count(A) (A)->number_of_hosts
319 #define memcached_server_name(A,B) (B).hostname
320 #define memcached_server_port(A,B) (B).port
321 #define memcached_server_list(A) (A)->hosts
322 #define memcached_server_response_count(A) (A)->cursor_active
325 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
328 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
330 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
332 void memcached_server_list_free(memcached_server_st
*ptr
);
333 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
335 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
336 char *hostname
, unsigned int port
,
337 memcached_return
*error
);
338 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
339 memcached_server_st
*memcached_servers_parse(char *server_strings
);
341 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
342 char *key
, memcached_return
*error
);
343 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
344 memcached_return
*error
);
346 char *memcached_get_by_key(memcached_st
*ptr
,
347 char *master_key
, size_t master_key_length
,
348 char *key
, size_t key_length
,
349 size_t *value_length
,
351 memcached_return
*error
);
353 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
354 char *master_key
, size_t master_key_length
,
355 char **keys
, size_t *key_length
,
356 unsigned int number_of_keys
);
358 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
359 char *master_key
, size_t master_key_length
,
360 char *key
, size_t key_length
,
361 char *value
, size_t value_length
,
365 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
366 char *master_key
, size_t master_key_length
,
367 char *key
, size_t key_length
,
368 char *value
, size_t value_length
,
372 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
373 char *master_key
, size_t master_key_length
,
374 char *key
, size_t key_length
,
375 char *value
, size_t value_length
,
379 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
380 char *master_key
, size_t master_key_length
,
381 char *key
, size_t key_length
,
382 char *value
, size_t value_length
,
386 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
387 char *master_key
, size_t master_key_length
,
388 char *key
, size_t key_length
,
389 char *value
, size_t value_length
,
393 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
394 char *master_key
, size_t master_key_length
,
395 char *key
, size_t key_length
,
396 char *value
, size_t value_length
,
400 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
401 char *master_key
, size_t master_key_length
,
402 char *key
, size_t key_length
,
405 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
406 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
408 unsigned int number_of_callbacks
411 memcached_return
memcached_callback_set(memcached_st
*ptr
,
412 memcached_callback flag
,
414 void *memcached_callback_get(memcached_st
*ptr
,
415 memcached_callback flag
,
416 memcached_return
*error
);
418 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
419 memcached_server_function
*callback
,
421 unsigned int number_of_callbacks
);
424 void memcached_result_free(memcached_result_st
*result
);
425 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
426 memcached_result_st
*result
);
427 #define memcached_result_key_value(A) (A)->key
428 #define memcached_result_key_length(A) (A)->key_length
430 #define memcached_result_value(A) memcached_string_value((A)->value)
431 #define memcached_result_length(A) memcached_string_length((A)->value)
433 char *memcached_result_value(memcached_result_st
*ptr
);
434 size_t memcached_result_length(memcached_result_st
*ptr
);
436 #define memcached_result_flags(A) (A)->flags
437 #define memcached_result_cas(A) (A)->cas
440 #ifndef __WATCHPOINT_H__
441 #define __WATCHPOINT_H__
442 /* Some personal debugging functions */
444 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
445 #ifdef __MEMCACHED_H__
446 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
447 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
449 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
450 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
451 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
452 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
453 #define WATCHPOINT_ASSERT(A) assert((A));
456 #ifdef __MEMCACHED_H__
457 #define WATCHPOINT_ERROR(A)
458 #define WATCHPOINT_IFERROR(A)
460 #define WATCHPOINT_STRING(A)
461 #define WATCHPOINT_NUMBER(A)
462 #define WATCHPOINT_ERRNO(A)
463 #define WATCHPOINT_ASSERT(A)
466 #endif /* __WATCHPOINT_H__ */
473 #endif /* __MEMCACHED_H__ */