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
;
107 MEMCACHED_CALLBACK_USER_DATA
,
108 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
109 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
110 MEMCACHED_CALLBACK_MALLOC_FUNCTION
,
111 MEMCACHED_CALLBACK_REALLOC_FUNCTION
,
112 MEMCACHED_CALLBACK_FREE_FUNCTION
,
113 } memcached_callback
;
116 MEMCACHED_HASH_DEFAULT
= 0,
119 MEMCACHED_HASH_FNV1_64
,
120 MEMCACHED_HASH_FNV1A_64
,
121 MEMCACHED_HASH_FNV1_32
,
122 MEMCACHED_HASH_FNV1A_32
,
123 MEMCACHED_HASH_KETAMA
,
124 MEMCACHED_HASH_HSIEH
,
128 MEMCACHED_CONNECTION_UNKNOWN
,
129 MEMCACHED_CONNECTION_TCP
,
130 MEMCACHED_CONNECTION_UDP
,
131 MEMCACHED_CONNECTION_UNIX_SOCKET
,
132 } memcached_connection
;
135 MEMCACHED_NOT_ALLOCATED
,
138 } memcached_allocated
;
140 struct memcached_server_st
{
141 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
145 unsigned int cursor_active
;
146 char write_buffer
[MEMCACHED_MAX_BUFFER
];
147 size_t write_buffer_offset
;
148 char read_buffer
[MEMCACHED_MAX_BUFFER
];
149 size_t read_data_length
;
150 size_t read_buffer_length
;
152 memcached_allocated sockaddr_inited
;
153 struct addrinfo
*address_info
;
154 memcached_connection type
;
155 uint8_t major_version
;
156 uint8_t minor_version
;
157 uint8_t micro_version
;
162 struct memcached_stat_st
{
167 uint32_t pointer_size
;
168 uint32_t rusage_user_seconds
;
169 uint32_t rusage_user_microseconds
;
170 uint32_t rusage_system_seconds
;
171 uint32_t rusage_system_microseconds
;
173 uint32_t total_items
;
174 uint64_t limit_maxbytes
;
175 uint32_t curr_connections
;
176 uint32_t total_connections
;
177 uint32_t connection_structures
;
185 uint64_t bytes_written
;
186 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
189 struct memcached_string_st
{
191 memcached_allocated is_allocated
;
198 struct memcached_result_st
{
199 memcached_allocated is_allocated
;
201 char key
[MEMCACHED_MAX_KEY
];
203 memcached_string_st value
;
206 /* Add result callback function */
209 struct memcached_st
{
210 memcached_allocated is_allocated
;
211 memcached_server_st
*hosts
;
212 unsigned int number_of_hosts
;
213 unsigned int cursor_server
;
218 int32_t poll_timeout
;
219 memcached_result_st result
;
221 memcached_server_distribution distribution
;
223 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
224 memcached_clone_func on_clone
;
225 memcached_cleanup_func on_cleanup
;
226 memcached_free_function call_free
;
227 memcached_malloc_function call_malloc
;
228 memcached_realloc_function call_realloc
;
229 #ifdef NOT_USED /* Future Use */
231 memcached_return warning
;
236 const char * memcached_lib_version(void);
238 memcached_st
*memcached_create(memcached_st
*ptr
);
239 void memcached_free(memcached_st
*ptr
);
240 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
242 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
244 memcached_return
memcached_increment(memcached_st
*ptr
,
245 char *key
, size_t key_length
,
248 memcached_return
memcached_decrement(memcached_st
*ptr
,
249 char *key
, size_t key_length
,
252 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
253 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
254 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
255 char *hostname
, unsigned int port
);
256 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
257 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
258 void memcached_quit(memcached_st
*ptr
);
259 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
260 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
261 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
263 /* All of the functions for adding data to the server */
264 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
265 char *value
, size_t value_length
,
268 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
269 char *value
, size_t value_length
,
272 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
273 char *value
, size_t value_length
,
276 memcached_return
memcached_append(memcached_st
*ptr
,
277 char *key
, size_t key_length
,
278 char *value
, size_t value_length
,
281 memcached_return
memcached_prepend(memcached_st
*ptr
,
282 char *key
, size_t key_length
,
283 char *value
, size_t value_length
,
286 memcached_return
memcached_cas(memcached_st
*ptr
,
287 char *key
, size_t key_length
,
288 char *value
, size_t value_length
,
294 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
295 size_t *value_length
,
297 memcached_return
*error
);
298 memcached_return
memcached_mget(memcached_st
*ptr
,
299 char **keys
, size_t *key_length
,
300 unsigned int number_of_keys
);
301 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
302 size_t *value_length
, uint32_t *flags
,
303 memcached_return
*error
);
304 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
305 memcached_result_st
*result
,
306 memcached_return
*error
);
308 /* Server Public functions */
309 #define memcached_server_count(A) (A)->number_of_hosts
310 #define memcached_server_name(A,B) (B).hostname
311 #define memcached_server_port(A,B) (B).port
312 #define memcached_server_list(A) (A)->hosts
313 #define memcached_server_response_count(A) (A)->cursor_active
316 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
319 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
321 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
323 void memcached_server_list_free(memcached_server_st
*ptr
);
324 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
326 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
327 char *hostname
, unsigned int port
,
328 memcached_return
*error
);
329 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
330 memcached_server_st
*memcached_servers_parse(char *server_strings
);
332 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
333 char *key
, memcached_return
*error
);
334 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
335 memcached_return
*error
);
337 char *memcached_get_by_key(memcached_st
*ptr
,
338 char *master_key
, size_t master_key_length
,
339 char *key
, size_t key_length
,
340 size_t *value_length
,
342 memcached_return
*error
);
344 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
345 char *master_key
, size_t master_key_length
,
346 char **keys
, size_t *key_length
,
347 unsigned int number_of_keys
);
349 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
350 char *master_key
, size_t master_key_length
,
351 char *key
, size_t key_length
,
352 char *value
, size_t value_length
,
356 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
357 char *master_key
, size_t master_key_length
,
358 char *key
, size_t key_length
,
359 char *value
, size_t value_length
,
363 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
364 char *master_key
, size_t master_key_length
,
365 char *key
, size_t key_length
,
366 char *value
, size_t value_length
,
370 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
371 char *master_key
, size_t master_key_length
,
372 char *key
, size_t key_length
,
373 char *value
, size_t value_length
,
377 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
378 char *master_key
, size_t master_key_length
,
379 char *key
, size_t key_length
,
380 char *value
, size_t value_length
,
384 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
385 char *master_key
, size_t master_key_length
,
386 char *key
, size_t key_length
,
387 char *value
, size_t value_length
,
391 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
392 char *master_key
, size_t master_key_length
,
393 char *key
, size_t key_length
,
396 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
397 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
399 unsigned int number_of_callbacks
402 memcached_return
memcached_callback_set(memcached_st
*ptr
,
403 memcached_callback flag
,
405 void *memcached_callback_get(memcached_st
*ptr
,
406 memcached_callback flag
,
407 memcached_return
*error
);
410 void memcached_result_free(memcached_result_st
*result
);
411 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
412 memcached_result_st
*result
);
413 #define memcached_result_key_value(A) (A)->key
414 #define memcached_result_key_length(A) (A)->key_length
416 #define memcached_result_value(A) memcached_string_value((A)->value)
417 #define memcached_result_length(A) memcached_string_length((A)->value)
419 char *memcached_result_value(memcached_result_st
*ptr
);
420 size_t memcached_result_length(memcached_result_st
*ptr
);
422 #define memcached_result_flags(A) (A)->flags
423 #define memcached_result_cas(A) (A)->cas
426 #ifndef __WATCHPOINT_H__
427 #define __WATCHPOINT_H__
428 /* Some personal debugging functions */
430 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
431 #ifdef __MEMCACHED_H__
432 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
433 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
435 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
436 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
437 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
438 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
439 #define WATCHPOINT_ASSERT(A) assert((A));
442 #ifdef __MEMCACHED_H__
443 #define WATCHPOINT_ERROR(A)
444 #define WATCHPOINT_IFERROR(A)
446 #define WATCHPOINT_STRING(A)
447 #define WATCHPOINT_NUMBER(A)
448 #define WATCHPOINT_ERRNO(A)
449 #define WATCHPOINT_ASSERT(A)
452 #endif /* __WATCHPOINT_H__ */
459 #endif /* __MEMCACHED_H__ */