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
);
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_SORT_HOSTS
,
104 MEMCACHED_BEHAVIOR_VERIFY_KEY
,
105 MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
,
106 } memcached_behavior
;
109 MEMCACHED_CALLBACK_USER_DATA
,
110 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
111 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
112 MEMCACHED_CALLBACK_MALLOC_FUNCTION
,
113 MEMCACHED_CALLBACK_REALLOC_FUNCTION
,
114 MEMCACHED_CALLBACK_FREE_FUNCTION
,
115 } memcached_callback
;
118 MEMCACHED_HASH_DEFAULT
= 0,
121 MEMCACHED_HASH_FNV1_64
,
122 MEMCACHED_HASH_FNV1A_64
,
123 MEMCACHED_HASH_FNV1_32
,
124 MEMCACHED_HASH_FNV1A_32
,
125 MEMCACHED_HASH_KETAMA
,
126 MEMCACHED_HASH_HSIEH
,
130 MEMCACHED_CONNECTION_UNKNOWN
,
131 MEMCACHED_CONNECTION_TCP
,
132 MEMCACHED_CONNECTION_UDP
,
133 MEMCACHED_CONNECTION_UNIX_SOCKET
,
134 } memcached_connection
;
137 MEMCACHED_NOT_ALLOCATED
,
140 } memcached_allocated
;
142 struct memcached_server_st
{
143 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
147 unsigned int cursor_active
;
148 char write_buffer
[MEMCACHED_MAX_BUFFER
];
149 size_t write_buffer_offset
;
150 char read_buffer
[MEMCACHED_MAX_BUFFER
];
151 size_t read_data_length
;
152 size_t read_buffer_length
;
154 memcached_allocated sockaddr_inited
;
155 struct addrinfo
*address_info
;
156 memcached_connection type
;
157 uint8_t major_version
;
158 uint8_t minor_version
;
159 uint8_t micro_version
;
164 struct memcached_stat_st
{
169 uint32_t pointer_size
;
170 uint32_t rusage_user_seconds
;
171 uint32_t rusage_user_microseconds
;
172 uint32_t rusage_system_seconds
;
173 uint32_t rusage_system_microseconds
;
175 uint32_t total_items
;
176 uint64_t limit_maxbytes
;
177 uint32_t curr_connections
;
178 uint32_t total_connections
;
179 uint32_t connection_structures
;
187 uint64_t bytes_written
;
188 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
191 struct memcached_string_st
{
193 memcached_allocated is_allocated
;
200 struct memcached_result_st
{
201 memcached_allocated is_allocated
;
203 char key
[MEMCACHED_MAX_KEY
];
205 memcached_string_st value
;
208 /* Add result callback function */
211 struct memcached_st
{
212 memcached_allocated is_allocated
;
213 memcached_server_st
*hosts
;
214 unsigned int number_of_hosts
;
215 unsigned int cursor_server
;
220 int32_t poll_timeout
;
221 int32_t connect_timeout
;
222 memcached_result_st result
;
224 memcached_server_distribution distribution
;
226 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
227 memcached_clone_func on_clone
;
228 memcached_cleanup_func on_cleanup
;
229 memcached_free_function call_free
;
230 memcached_malloc_function call_malloc
;
231 memcached_realloc_function call_realloc
;
232 #ifdef NOT_USED /* Future Use */
234 memcached_return warning
;
239 const char * memcached_lib_version(void);
241 memcached_st
*memcached_create(memcached_st
*ptr
);
242 void memcached_free(memcached_st
*ptr
);
243 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
245 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
247 memcached_return
memcached_increment(memcached_st
*ptr
,
248 char *key
, size_t key_length
,
251 memcached_return
memcached_decrement(memcached_st
*ptr
,
252 char *key
, size_t key_length
,
255 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
256 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
257 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
258 char *hostname
, unsigned int port
);
259 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
260 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
261 void memcached_quit(memcached_st
*ptr
);
262 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
263 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
264 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
266 /* All of the functions for adding data to the server */
267 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
268 char *value
, size_t value_length
,
271 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
272 char *value
, size_t value_length
,
275 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
276 char *value
, size_t value_length
,
279 memcached_return
memcached_append(memcached_st
*ptr
,
280 char *key
, size_t key_length
,
281 char *value
, size_t value_length
,
284 memcached_return
memcached_prepend(memcached_st
*ptr
,
285 char *key
, size_t key_length
,
286 char *value
, size_t value_length
,
289 memcached_return
memcached_cas(memcached_st
*ptr
,
290 char *key
, size_t key_length
,
291 char *value
, size_t value_length
,
297 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
298 size_t *value_length
,
300 memcached_return
*error
);
301 memcached_return
memcached_mget(memcached_st
*ptr
,
302 char **keys
, size_t *key_length
,
303 unsigned int number_of_keys
);
304 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
305 size_t *value_length
, uint32_t *flags
,
306 memcached_return
*error
);
307 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
308 memcached_result_st
*result
,
309 memcached_return
*error
);
311 /* Server Public functions */
312 #define memcached_server_count(A) (A)->number_of_hosts
313 #define memcached_server_name(A,B) (B).hostname
314 #define memcached_server_port(A,B) (B).port
315 #define memcached_server_list(A) (A)->hosts
316 #define memcached_server_response_count(A) (A)->cursor_active
319 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
322 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
324 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
326 void memcached_server_list_free(memcached_server_st
*ptr
);
327 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
329 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
330 char *hostname
, unsigned int port
,
331 memcached_return
*error
);
332 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
333 memcached_server_st
*memcached_servers_parse(char *server_strings
);
335 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
336 char *key
, memcached_return
*error
);
337 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
338 memcached_return
*error
);
340 char *memcached_get_by_key(memcached_st
*ptr
,
341 char *master_key
, size_t master_key_length
,
342 char *key
, size_t key_length
,
343 size_t *value_length
,
345 memcached_return
*error
);
347 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
348 char *master_key
, size_t master_key_length
,
349 char **keys
, size_t *key_length
,
350 unsigned int number_of_keys
);
352 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
353 char *master_key
, size_t master_key_length
,
354 char *key
, size_t key_length
,
355 char *value
, size_t value_length
,
359 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
360 char *master_key
, size_t master_key_length
,
361 char *key
, size_t key_length
,
362 char *value
, size_t value_length
,
366 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
367 char *master_key
, size_t master_key_length
,
368 char *key
, size_t key_length
,
369 char *value
, size_t value_length
,
373 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
374 char *master_key
, size_t master_key_length
,
375 char *key
, size_t key_length
,
376 char *value
, size_t value_length
,
380 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
381 char *master_key
, size_t master_key_length
,
382 char *key
, size_t key_length
,
383 char *value
, size_t value_length
,
387 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
388 char *master_key
, size_t master_key_length
,
389 char *key
, size_t key_length
,
390 char *value
, size_t value_length
,
394 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
395 char *master_key
, size_t master_key_length
,
396 char *key
, size_t key_length
,
399 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
400 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
402 unsigned int number_of_callbacks
405 memcached_return
memcached_callback_set(memcached_st
*ptr
,
406 memcached_callback flag
,
408 void *memcached_callback_get(memcached_st
*ptr
,
409 memcached_callback flag
,
410 memcached_return
*error
);
413 void memcached_result_free(memcached_result_st
*result
);
414 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
415 memcached_result_st
*result
);
416 #define memcached_result_key_value(A) (A)->key
417 #define memcached_result_key_length(A) (A)->key_length
419 #define memcached_result_value(A) memcached_string_value((A)->value)
420 #define memcached_result_length(A) memcached_string_length((A)->value)
422 char *memcached_result_value(memcached_result_st
*ptr
);
423 size_t memcached_result_length(memcached_result_st
*ptr
);
425 #define memcached_result_flags(A) (A)->flags
426 #define memcached_result_cas(A) (A)->cas
429 #ifndef __WATCHPOINT_H__
430 #define __WATCHPOINT_H__
431 /* Some personal debugging functions */
433 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
434 #ifdef __MEMCACHED_H__
435 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
436 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
438 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
439 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
440 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
441 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
442 #define WATCHPOINT_ASSERT(A) assert((A));
445 #ifdef __MEMCACHED_H__
446 #define WATCHPOINT_ERROR(A)
447 #define WATCHPOINT_IFERROR(A)
449 #define WATCHPOINT_STRING(A)
450 #define WATCHPOINT_NUMBER(A)
451 #define WATCHPOINT_ERRNO(A)
452 #define WATCHPOINT_ASSERT(A)
455 #endif /* __WATCHPOINT_H__ */
462 #endif /* __MEMCACHED_H__ */