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 (*clone_func
)(memcached_st
*parent
, memcached_st
*clone
);
76 typedef memcached_return (*cleanup_func
)(memcached_st
*ptr
);
80 MEMCACHED_DISTRIBUTION_MODULA
,
81 MEMCACHED_DISTRIBUTION_CONSISTENT
,
82 } memcached_server_distribution
;
85 MEMCACHED_BEHAVIOR_NO_BLOCK
,
86 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
87 MEMCACHED_BEHAVIOR_HASH
,
88 MEMCACHED_BEHAVIOR_KETAMA
,
89 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
90 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
91 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
92 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
93 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
94 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
95 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
96 MEMCACHED_BEHAVIOR_USER_DATA
,
100 MEMCACHED_CALLBACK_USER_DATA
,
101 MEMCACHED_CALLBACK_CLEANUP_FUNCTION
,
102 MEMCACHED_CALLBACK_CLONE_FUNCTION
,
103 } memcached_callback
;
106 MEMCACHED_HASH_DEFAULT
= 0,
109 MEMCACHED_HASH_FNV1_64
,
110 MEMCACHED_HASH_FNV1A_64
,
111 MEMCACHED_HASH_FNV1_32
,
112 MEMCACHED_HASH_FNV1A_32
,
113 MEMCACHED_HASH_KETAMA
,
114 MEMCACHED_HASH_HSIEH
,
118 MEMCACHED_CONNECTION_UNKNOWN
,
119 MEMCACHED_CONNECTION_TCP
,
120 MEMCACHED_CONNECTION_UDP
,
121 MEMCACHED_CONNECTION_UNIX_SOCKET
,
122 } memcached_connection
;
125 MEMCACHED_NOT_ALLOCATED
,
128 } memcached_allocated
;
130 struct memcached_server_st
{
131 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
134 unsigned int cursor_active
;
135 char write_buffer
[MEMCACHED_MAX_BUFFER
];
136 size_t write_buffer_offset
;
138 char read_buffer
[MEMCACHED_MAX_BUFFER
];
139 size_t read_data_length
;
140 size_t read_buffer_length
;
142 memcached_allocated sockaddr_inited
;
143 struct addrinfo
*address_info
;
144 memcached_connection type
;
145 uint8_t major_version
;
146 uint8_t minor_version
;
147 uint8_t micro_version
;
151 struct memcached_stat_st
{
156 uint32_t pointer_size
;
157 uint32_t rusage_user_seconds
;
158 uint32_t rusage_user_microseconds
;
159 uint32_t rusage_system_seconds
;
160 uint32_t rusage_system_microseconds
;
162 uint32_t total_items
;
163 uint32_t limit_maxbytes
;
164 uint32_t curr_connections
;
165 uint32_t total_connections
;
166 uint32_t connection_structures
;
174 uint64_t bytes_written
;
175 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
178 struct memcached_string_st
{
180 memcached_allocated is_allocated
;
187 struct memcached_result_st
{
188 memcached_allocated is_allocated
;
190 char key
[MEMCACHED_MAX_KEY
];
192 memcached_string_st value
;
195 /* Add result callback function */
198 struct memcached_st
{
199 memcached_allocated is_allocated
;
200 memcached_server_st
*hosts
;
201 unsigned int number_of_hosts
;
202 unsigned int cursor_server
;
205 unsigned long long flags
;
208 int32_t poll_timeout
;
209 memcached_result_st result
;
211 memcached_server_distribution distribution
;
213 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
215 cleanup_func on_cleanup
;
216 #ifdef NOT_USED /* Future Use */
218 memcached_return warning
;
223 memcached_st
*memcached_create(memcached_st
*ptr
);
224 void memcached_free(memcached_st
*ptr
);
225 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
227 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
229 memcached_return
memcached_increment(memcached_st
*ptr
,
230 char *key
, size_t key_length
,
233 memcached_return
memcached_decrement(memcached_st
*ptr
,
234 char *key
, size_t key_length
,
237 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
238 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
239 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
240 char *hostname
, unsigned int port
);
241 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
242 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
243 void memcached_quit(memcached_st
*ptr
);
244 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
245 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
246 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
248 /* All of the functions for adding data to the server */
249 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
250 char *value
, size_t value_length
,
253 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
254 char *value
, size_t value_length
,
257 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
258 char *value
, size_t value_length
,
261 memcached_return
memcached_append(memcached_st
*ptr
,
262 char *key
, size_t key_length
,
263 char *value
, size_t value_length
,
266 memcached_return
memcached_prepend(memcached_st
*ptr
,
267 char *key
, size_t key_length
,
268 char *value
, size_t value_length
,
271 memcached_return
memcached_cas(memcached_st
*ptr
,
272 char *key
, size_t key_length
,
273 char *value
, size_t value_length
,
279 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
280 size_t *value_length
,
282 memcached_return
*error
);
283 memcached_return
memcached_mget(memcached_st
*ptr
,
284 char **keys
, size_t *key_length
,
285 unsigned int number_of_keys
);
286 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
287 size_t *value_length
, uint32_t *flags
,
288 memcached_return
*error
);
289 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
290 memcached_result_st
*result
,
291 memcached_return
*error
);
293 /* Server Public functions */
294 #define memcached_server_count(A) (A)->number_of_hosts
295 #define memcached_server_name(A,B) (B).hostname
296 #define memcached_server_port(A,B) (B).port
297 #define memcached_server_list(A) (A)->hosts
298 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
300 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
303 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
305 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
307 void memcached_server_list_free(memcached_server_st
*ptr
);
308 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
310 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
311 char *hostname
, unsigned int port
,
312 memcached_return
*error
);
313 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
314 memcached_server_st
*memcached_servers_parse(char *server_strings
);
316 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
317 char *key
, memcached_return
*error
);
318 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
319 memcached_return
*error
);
321 char *memcached_get_by_key(memcached_st
*ptr
,
322 char *master_key
, size_t master_key_length
,
323 char *key
, size_t key_length
,
324 size_t *value_length
,
326 memcached_return
*error
);
328 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
329 char *master_key
, size_t master_key_length
,
330 char **keys
, size_t *key_length
,
331 unsigned int number_of_keys
);
333 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
334 char *master_key
, size_t master_key_length
,
335 char *key
, size_t key_length
,
336 char *value
, size_t value_length
,
340 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
341 char *master_key
, size_t master_key_length
,
342 char *key
, size_t key_length
,
343 char *value
, size_t value_length
,
347 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
348 char *master_key
, size_t master_key_length
,
349 char *key
, size_t key_length
,
350 char *value
, size_t value_length
,
354 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
355 char *master_key
, size_t master_key_length
,
356 char *key
, size_t key_length
,
357 char *value
, size_t value_length
,
361 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
362 char *master_key
, size_t master_key_length
,
363 char *key
, size_t key_length
,
364 char *value
, size_t value_length
,
368 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
369 char *master_key
, size_t master_key_length
,
370 char *key
, size_t key_length
,
371 char *value
, size_t value_length
,
375 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
376 char *master_key
, size_t master_key_length
,
377 char *key
, size_t key_length
,
380 memcached_return
memcached_mdelete(memcached_st
*ptr
,
381 char **key
, size_t *key_length
,
382 unsigned int number_of_keys
,
385 memcached_return
memcached_mdelete_by_key(memcached_st
*ptr
,
386 char *master_key
, size_t master_key_length
,
387 char **key
, size_t *key_length
,
388 unsigned int number_of_keys
,
391 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
392 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
394 unsigned int number_of_callbacks
397 memcached_return
memcached_callback_set(memcached_st
*ptr
,
398 memcached_callback flag
,
400 void *memcached_callback_get(memcached_st
*ptr
,
401 memcached_callback flag
,
402 memcached_return
*error
);
405 void memcached_result_free(memcached_result_st
*result
);
406 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
407 memcached_result_st
*result
);
408 #define memcached_result_key_value(A) (A)->key
409 #define memcached_result_key_length(A) (A)->key_length
411 #define memcached_result_value(A) memcached_string_value((A)->value)
412 #define memcached_result_length(A) memcached_string_length((A)->value)
414 char *memcached_result_value(memcached_result_st
*ptr
);
415 size_t memcached_result_length(memcached_result_st
*ptr
);
417 #define memcached_result_flags(A) (A)->flags
418 #define memcached_result_cas(A) (A)->cas
421 #ifndef __WATCHPOINT_H__
422 #define __WATCHPOINT_H__
423 /* Some personal debugging functions */
425 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
426 #ifdef __MEMCACHED_H__
427 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
428 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
430 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
431 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
432 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
433 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
434 #define WATCHPOINT_ASSERT(A) assert((A));
437 #ifdef __MEMCACHED_H__
438 #define WATCHPOINT_ERROR(A)
439 #define WATCHPOINT_IFERROR(A)
441 #define WATCHPOINT_STRING(A)
442 #define WATCHPOINT_NUMBER(A)
443 #define WATCHPOINT_ERRNO(A)
444 #define WATCHPOINT_ASSERT(A)
447 #endif /* __WATCHPOINT_H__ */
454 #endif /* __MEMCACHED_H__ */