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.14"
37 #define MEMCACHED_MAJOR_VERSION 0
38 #define MEMCACHED_MAJOR_VERSION 14
39 #define MEMCACHED_MICRO_VERSION 0
44 MEMCACHED_HOST_LOOKUP_FAILURE
,
45 MEMCACHED_CONNECTION_FAILURE
,
46 MEMCACHED_CONNECTION_BIND_FAILURE
,
47 MEMCACHED_WRITE_FAILURE
,
48 MEMCACHED_READ_FAILURE
,
49 MEMCACHED_UNKNOWN_READ_FAILURE
,
50 MEMCACHED_PROTOCOL_ERROR
,
51 MEMCACHED_CLIENT_ERROR
,
52 MEMCACHED_SERVER_ERROR
,
53 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
54 MEMCACHED_DATA_EXISTS
,
55 MEMCACHED_DATA_DOES_NOT_EXIST
,
59 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
60 MEMCACHED_PARTIAL_READ
,
61 MEMCACHED_SOME_ERRORS
,
68 MEMCACHED_FAIL_UNIX_SOCKET
,
69 MEMCACHED_NOT_SUPPORTED
,
70 MEMCACHED_NO_KEY_PROVIDED
,
71 MEMCACHED_FETCH_NOTFINISHED
,
74 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
77 typedef struct memcached_st memcached_st
;
78 typedef struct memcached_stat_st memcached_stat_st
;
79 typedef struct memcached_result_st memcached_result_st
;
80 typedef struct memcached_string_st memcached_string_st
;
81 typedef struct memcached_server_st memcached_server_st
;
82 typedef memcached_return (*memcached_clone_func
)(memcached_st
*parent
, memcached_st
*clone
);
83 typedef memcached_return (*memcached_cleanup_func
)(memcached_st
*ptr
);
84 typedef void (*memcached_free_function
)(memcached_st
*ptr
, void *mem
);
85 typedef void *(*memcached_malloc_function
)(memcached_st
*ptr
, const size_t size
);
86 typedef void *(*memcached_realloc_function
)(memcached_st
*ptr
, void *mem
, const size_t size
);
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_USER_DATA
,
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
];
146 unsigned int cursor_active
;
147 char write_buffer
[MEMCACHED_MAX_BUFFER
];
148 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
;
163 struct memcached_stat_st
{
168 uint32_t pointer_size
;
169 uint32_t rusage_user_seconds
;
170 uint32_t rusage_user_microseconds
;
171 uint32_t rusage_system_seconds
;
172 uint32_t rusage_system_microseconds
;
174 uint32_t total_items
;
175 uint32_t limit_maxbytes
;
176 uint32_t curr_connections
;
177 uint32_t total_connections
;
178 uint32_t connection_structures
;
186 uint64_t bytes_written
;
187 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
190 struct memcached_string_st
{
192 memcached_allocated is_allocated
;
199 struct memcached_result_st
{
200 memcached_allocated is_allocated
;
202 char key
[MEMCACHED_MAX_KEY
];
204 memcached_string_st value
;
207 /* Add result callback function */
210 struct memcached_st
{
211 memcached_allocated is_allocated
;
212 memcached_server_st
*hosts
;
213 unsigned int number_of_hosts
;
214 unsigned int cursor_server
;
217 unsigned long long flags
;
220 int32_t poll_timeout
;
221 memcached_result_st result
;
223 memcached_server_distribution distribution
;
225 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
226 memcached_clone_func on_clone
;
227 memcached_cleanup_func on_cleanup
;
228 memcached_free_function call_free
;
229 memcached_malloc_function call_malloc
;
230 memcached_realloc_function call_realloc
;
231 #ifdef NOT_USED /* Future Use */
233 memcached_return warning
;
238 const char * memcached_lib_version(void);
240 memcached_st
*memcached_create(memcached_st
*ptr
);
241 void memcached_free(memcached_st
*ptr
);
242 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
244 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
246 memcached_return
memcached_increment(memcached_st
*ptr
,
247 char *key
, size_t key_length
,
250 memcached_return
memcached_decrement(memcached_st
*ptr
,
251 char *key
, size_t key_length
,
254 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
255 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
256 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
257 char *hostname
, unsigned int port
);
258 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
259 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
260 void memcached_quit(memcached_st
*ptr
);
261 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
262 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
263 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
265 /* All of the functions for adding data to the server */
266 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
267 char *value
, size_t value_length
,
270 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
271 char *value
, size_t value_length
,
274 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
275 char *value
, size_t value_length
,
278 memcached_return
memcached_append(memcached_st
*ptr
,
279 char *key
, size_t key_length
,
280 char *value
, size_t value_length
,
283 memcached_return
memcached_prepend(memcached_st
*ptr
,
284 char *key
, size_t key_length
,
285 char *value
, size_t value_length
,
288 memcached_return
memcached_cas(memcached_st
*ptr
,
289 char *key
, size_t key_length
,
290 char *value
, size_t value_length
,
296 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
297 size_t *value_length
,
299 memcached_return
*error
);
300 memcached_return
memcached_mget(memcached_st
*ptr
,
301 char **keys
, size_t *key_length
,
302 unsigned int number_of_keys
);
303 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
304 size_t *value_length
, uint32_t *flags
,
305 memcached_return
*error
);
306 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
307 memcached_result_st
*result
,
308 memcached_return
*error
);
310 /* Server Public functions */
311 #define memcached_server_count(A) (A)->number_of_hosts
312 #define memcached_server_name(A,B) (B).hostname
313 #define memcached_server_port(A,B) (B).port
314 #define memcached_server_list(A) (A)->hosts
315 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
317 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
320 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
322 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
324 void memcached_server_list_free(memcached_server_st
*ptr
);
325 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
327 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
328 char *hostname
, unsigned int port
,
329 memcached_return
*error
);
330 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
331 memcached_server_st
*memcached_servers_parse(char *server_strings
);
333 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
334 char *key
, memcached_return
*error
);
335 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
336 memcached_return
*error
);
338 char *memcached_get_by_key(memcached_st
*ptr
,
339 char *master_key
, size_t master_key_length
,
340 char *key
, size_t key_length
,
341 size_t *value_length
,
343 memcached_return
*error
);
345 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
346 char *master_key
, size_t master_key_length
,
347 char **keys
, size_t *key_length
,
348 unsigned int number_of_keys
);
350 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
351 char *master_key
, size_t master_key_length
,
352 char *key
, size_t key_length
,
353 char *value
, size_t value_length
,
357 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
358 char *master_key
, size_t master_key_length
,
359 char *key
, size_t key_length
,
360 char *value
, size_t value_length
,
364 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
365 char *master_key
, size_t master_key_length
,
366 char *key
, size_t key_length
,
367 char *value
, size_t value_length
,
371 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
372 char *master_key
, size_t master_key_length
,
373 char *key
, size_t key_length
,
374 char *value
, size_t value_length
,
378 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
379 char *master_key
, size_t master_key_length
,
380 char *key
, size_t key_length
,
381 char *value
, size_t value_length
,
385 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
386 char *master_key
, size_t master_key_length
,
387 char *key
, size_t key_length
,
388 char *value
, size_t value_length
,
392 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
393 char *master_key
, size_t master_key_length
,
394 char *key
, size_t key_length
,
397 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
398 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
400 unsigned int number_of_callbacks
403 memcached_return
memcached_callback_set(memcached_st
*ptr
,
404 memcached_callback flag
,
406 void *memcached_callback_get(memcached_st
*ptr
,
407 memcached_callback flag
,
408 memcached_return
*error
);
411 void memcached_result_free(memcached_result_st
*result
);
412 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
413 memcached_result_st
*result
);
414 #define memcached_result_key_value(A) (A)->key
415 #define memcached_result_key_length(A) (A)->key_length
417 #define memcached_result_value(A) memcached_string_value((A)->value)
418 #define memcached_result_length(A) memcached_string_length((A)->value)
420 char *memcached_result_value(memcached_result_st
*ptr
);
421 size_t memcached_result_length(memcached_result_st
*ptr
);
423 #define memcached_result_flags(A) (A)->flags
424 #define memcached_result_cas(A) (A)->cas
427 #ifndef __WATCHPOINT_H__
428 #define __WATCHPOINT_H__
429 /* Some personal debugging functions */
431 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
432 #ifdef __MEMCACHED_H__
433 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
434 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
436 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
437 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
438 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
439 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
440 #define WATCHPOINT_ASSERT(A) assert((A));
443 #ifdef __MEMCACHED_H__
444 #define WATCHPOINT_ERROR(A)
445 #define WATCHPOINT_IFERROR(A)
447 #define WATCHPOINT_STRING(A)
448 #define WATCHPOINT_NUMBER(A)
449 #define WATCHPOINT_ERRNO(A)
450 #define WATCHPOINT_ASSERT(A)
453 #endif /* __WATCHPOINT_H__ */
460 #endif /* __MEMCACHED_H__ */