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
37 MEMCACHED_HOST_LOOKUP_FAILURE
,
38 MEMCACHED_CONNECTION_FAILURE
,
39 MEMCACHED_CONNECTION_BIND_FAILURE
,
40 MEMCACHED_WRITE_FAILURE
,
41 MEMCACHED_READ_FAILURE
,
42 MEMCACHED_UNKNOWN_READ_FAILURE
,
43 MEMCACHED_PROTOCOL_ERROR
,
44 MEMCACHED_CLIENT_ERROR
,
45 MEMCACHED_SERVER_ERROR
,
46 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
47 MEMCACHED_DATA_EXISTS
,
48 MEMCACHED_DATA_DOES_NOT_EXIST
,
52 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
53 MEMCACHED_PARTIAL_READ
,
54 MEMCACHED_SOME_ERRORS
,
61 MEMCACHED_FAIL_UNIX_SOCKET
,
62 MEMCACHED_NOT_SUPPORTED
,
63 MEMCACHED_NO_KEY_PROVIDED
,
64 MEMCACHED_FETCH_NOTFINISHED
,
67 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
70 typedef struct memcached_st memcached_st
;
71 typedef struct memcached_stat_st memcached_stat_st
;
72 typedef struct memcached_result_st memcached_result_st
;
73 typedef struct memcached_string_st memcached_string_st
;
74 typedef struct memcached_server_st memcached_server_st
;
75 typedef memcached_return (*memcached_clone_func
)(memcached_st
*parent
, memcached_st
*clone
);
76 typedef memcached_return (*memcached_cleanup_func
)(memcached_st
*ptr
);
77 typedef void (*memcached_free_function
)(memcached_st
*ptr
, void *mem
);
78 typedef void *(*memcached_malloc_function
)(memcached_st
*ptr
, const size_t size
);
79 typedef void *(*memcached_realloc_function
)(memcached_st
*ptr
, void *mem
, const size_t size
);
82 MEMCACHED_DISTRIBUTION_MODULA
,
83 MEMCACHED_DISTRIBUTION_CONSISTENT
,
84 } memcached_server_distribution
;
87 MEMCACHED_BEHAVIOR_NO_BLOCK
,
88 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
89 MEMCACHED_BEHAVIOR_HASH
,
90 MEMCACHED_BEHAVIOR_KETAMA
,
91 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
92 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
93 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
94 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
95 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
96 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
97 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
98 MEMCACHED_BEHAVIOR_USER_DATA
,
102 MEMCACHED_CALLBACK_USER_DATA
,
103 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
104 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
105 MEMCACHED_CALLBACK_MALLOC_FUNCTION
,
106 MEMCACHED_CALLBACK_REALLOC_FUNCTION
,
107 MEMCACHED_CALLBACK_FREE_FUNCTION
,
108 } memcached_callback
;
111 MEMCACHED_HASH_DEFAULT
= 0,
114 MEMCACHED_HASH_FNV1_64
,
115 MEMCACHED_HASH_FNV1A_64
,
116 MEMCACHED_HASH_FNV1_32
,
117 MEMCACHED_HASH_FNV1A_32
,
118 MEMCACHED_HASH_KETAMA
,
119 MEMCACHED_HASH_HSIEH
,
123 MEMCACHED_CONNECTION_UNKNOWN
,
124 MEMCACHED_CONNECTION_TCP
,
125 MEMCACHED_CONNECTION_UDP
,
126 MEMCACHED_CONNECTION_UNIX_SOCKET
,
127 } memcached_connection
;
130 MEMCACHED_NOT_ALLOCATED
,
133 } memcached_allocated
;
135 struct memcached_server_st
{
136 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
140 unsigned int cursor_active
;
141 char write_buffer
[MEMCACHED_MAX_BUFFER
];
142 size_t write_buffer_offset
;
143 char read_buffer
[MEMCACHED_MAX_BUFFER
];
144 size_t read_data_length
;
145 size_t read_buffer_length
;
147 memcached_allocated sockaddr_inited
;
148 struct addrinfo
*address_info
;
149 memcached_connection type
;
150 uint8_t major_version
;
151 uint8_t minor_version
;
152 uint8_t micro_version
;
157 struct memcached_stat_st
{
162 uint32_t pointer_size
;
163 uint32_t rusage_user_seconds
;
164 uint32_t rusage_user_microseconds
;
165 uint32_t rusage_system_seconds
;
166 uint32_t rusage_system_microseconds
;
168 uint32_t total_items
;
169 uint32_t limit_maxbytes
;
170 uint32_t curr_connections
;
171 uint32_t total_connections
;
172 uint32_t connection_structures
;
180 uint64_t bytes_written
;
181 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
184 struct memcached_string_st
{
186 memcached_allocated is_allocated
;
193 struct memcached_result_st
{
194 memcached_allocated is_allocated
;
196 char key
[MEMCACHED_MAX_KEY
];
198 memcached_string_st value
;
201 /* Add result callback function */
204 struct memcached_st
{
205 memcached_allocated is_allocated
;
206 memcached_server_st
*hosts
;
207 unsigned int number_of_hosts
;
208 unsigned int cursor_server
;
213 int32_t poll_timeout
;
214 memcached_result_st result
;
216 memcached_server_distribution distribution
;
218 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
219 memcached_clone_func on_clone
;
220 memcached_cleanup_func on_cleanup
;
221 memcached_free_function call_free
;
222 memcached_malloc_function call_malloc
;
223 memcached_realloc_function call_realloc
;
224 #ifdef NOT_USED /* Future Use */
226 memcached_return warning
;
231 memcached_st
*memcached_create(memcached_st
*ptr
);
232 void memcached_free(memcached_st
*ptr
);
233 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
235 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
237 memcached_return
memcached_increment(memcached_st
*ptr
,
238 char *key
, size_t key_length
,
241 memcached_return
memcached_decrement(memcached_st
*ptr
,
242 char *key
, size_t key_length
,
245 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
246 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
247 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
248 char *hostname
, unsigned int port
);
249 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
250 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
251 void memcached_quit(memcached_st
*ptr
);
252 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
253 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
254 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
256 /* All of the functions for adding data to the server */
257 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
258 char *value
, size_t value_length
,
261 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
262 char *value
, size_t value_length
,
265 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
266 char *value
, size_t value_length
,
269 memcached_return
memcached_append(memcached_st
*ptr
,
270 char *key
, size_t key_length
,
271 char *value
, size_t value_length
,
274 memcached_return
memcached_prepend(memcached_st
*ptr
,
275 char *key
, size_t key_length
,
276 char *value
, size_t value_length
,
279 memcached_return
memcached_cas(memcached_st
*ptr
,
280 char *key
, size_t key_length
,
281 char *value
, size_t value_length
,
287 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
288 size_t *value_length
,
290 memcached_return
*error
);
291 memcached_return
memcached_mget(memcached_st
*ptr
,
292 char **keys
, size_t *key_length
,
293 unsigned int number_of_keys
);
294 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
295 size_t *value_length
, uint32_t *flags
,
296 memcached_return
*error
);
297 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
298 memcached_result_st
*result
,
299 memcached_return
*error
);
301 /* Server Public functions */
302 #define memcached_server_count(A) (A)->number_of_hosts
303 #define memcached_server_name(A,B) (B).hostname
304 #define memcached_server_port(A,B) (B).port
305 #define memcached_server_list(A) (A)->hosts
306 #define memcached_server_response_count(A) (A)->cursor_active
309 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
312 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
314 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
316 void memcached_server_list_free(memcached_server_st
*ptr
);
317 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
319 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
320 char *hostname
, unsigned int port
,
321 memcached_return
*error
);
322 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
323 memcached_server_st
*memcached_servers_parse(char *server_strings
);
325 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
326 char *key
, memcached_return
*error
);
327 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
328 memcached_return
*error
);
330 char *memcached_get_by_key(memcached_st
*ptr
,
331 char *master_key
, size_t master_key_length
,
332 char *key
, size_t key_length
,
333 size_t *value_length
,
335 memcached_return
*error
);
337 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
338 char *master_key
, size_t master_key_length
,
339 char **keys
, size_t *key_length
,
340 unsigned int number_of_keys
);
342 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
343 char *master_key
, size_t master_key_length
,
344 char *key
, size_t key_length
,
345 char *value
, size_t value_length
,
349 memcached_return
memcached_add_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_replace_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_prepend_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_append_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_cas_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_delete_by_key(memcached_st
*ptr
,
385 char *master_key
, size_t master_key_length
,
386 char *key
, size_t key_length
,
389 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
390 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
392 unsigned int number_of_callbacks
395 memcached_return
memcached_callback_set(memcached_st
*ptr
,
396 memcached_callback flag
,
398 void *memcached_callback_get(memcached_st
*ptr
,
399 memcached_callback flag
,
400 memcached_return
*error
);
403 void memcached_result_free(memcached_result_st
*result
);
404 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
405 memcached_result_st
*result
);
406 #define memcached_result_key_value(A) (A)->key
407 #define memcached_result_key_length(A) (A)->key_length
409 #define memcached_result_value(A) memcached_string_value((A)->value)
410 #define memcached_result_length(A) memcached_string_length((A)->value)
412 char *memcached_result_value(memcached_result_st
*ptr
);
413 size_t memcached_result_length(memcached_result_st
*ptr
);
415 #define memcached_result_flags(A) (A)->flags
416 #define memcached_result_cas(A) (A)->cas
419 #ifndef __WATCHPOINT_H__
420 #define __WATCHPOINT_H__
421 /* Some personal debugging functions */
423 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
424 #ifdef __MEMCACHED_H__
425 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
426 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
428 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
429 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
430 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
431 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
432 #define WATCHPOINT_ASSERT(A) assert((A));
435 #ifdef __MEMCACHED_H__
436 #define WATCHPOINT_ERROR(A)
437 #define WATCHPOINT_IFERROR(A)
439 #define WATCHPOINT_STRING(A)
440 #define WATCHPOINT_NUMBER(A)
441 #define WATCHPOINT_ERRNO(A)
442 #define WATCHPOINT_ASSERT(A)
445 #endif /* __WATCHPOINT_H__ */
452 #endif /* __MEMCACHED_H__ */