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 typedef struct memcached_st memcached_st
;
23 typedef struct memcached_stat_st memcached_stat_st
;
24 typedef struct memcached_result_st memcached_result_st
;
25 typedef struct memcached_string_st memcached_string_st
;
26 typedef struct memcached_server_st memcached_server_st
;
28 #define MEMCACHED_VERSION_STRING 12
29 #define MEMCACHED_DEFAULT_PORT 11211
30 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
31 #define SMALL_STRING_LEN 1024
32 #define HUGE_STRING_LEN 8196
33 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
34 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
35 #define MEMCACHED_MAX_HOST_LENGTH 64
36 #define MEMCACHED_WHEEL_SIZE 1024
37 #define MEMCACHED_STRIDE 4
38 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
43 MEMCACHED_HOST_LOOKUP_FAILURE
,
44 MEMCACHED_CONNECTION_FAILURE
,
45 MEMCACHED_CONNECTION_BIND_FAILURE
,
46 MEMCACHED_WRITE_FAILURE
,
47 MEMCACHED_READ_FAILURE
,
48 MEMCACHED_UNKNOWN_READ_FAILURE
,
49 MEMCACHED_PROTOCOL_ERROR
,
50 MEMCACHED_CLIENT_ERROR
,
51 MEMCACHED_SERVER_ERROR
,
52 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
53 MEMCACHED_DATA_EXISTS
,
54 MEMCACHED_DATA_DOES_NOT_EXIST
,
58 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
59 MEMCACHED_PARTIAL_READ
,
60 MEMCACHED_SOME_ERRORS
,
67 MEMCACHED_FAIL_UNIX_SOCKET
,
68 MEMCACHED_NOT_SUPPORTED
,
69 MEMCACHED_NO_KEY_PROVIDED
,
70 MEMCACHED_FETCH_NOTFINISHED
,
72 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
76 MEMCACHED_DISTRIBUTION_MODULA
,
77 MEMCACHED_DISTRIBUTION_CONSISTENT
,
78 } memcached_server_distribution
;
81 MEMCACHED_BEHAVIOR_NO_BLOCK
,
82 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
83 MEMCACHED_BEHAVIOR_HASH
,
84 MEMCACHED_BEHAVIOR_KETAMA
,
85 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
86 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
87 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
88 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
89 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
90 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
94 MEMCACHED_HASH_DEFAULT
= 0,
97 MEMCACHED_HASH_FNV1_64
,
98 MEMCACHED_HASH_FNV1A_64
,
99 MEMCACHED_HASH_FNV1_32
,
100 MEMCACHED_HASH_FNV1A_32
,
101 MEMCACHED_HASH_KETAMA
,
102 MEMCACHED_HASH_HSIEH
,
106 MEMCACHED_CONNECTION_UNKNOWN
,
107 MEMCACHED_CONNECTION_TCP
,
108 MEMCACHED_CONNECTION_UDP
,
109 MEMCACHED_CONNECTION_UNIX_SOCKET
,
110 } memcached_connection
;
113 MEMCACHED_NOT_ALLOCATED
,
116 } memcached_allocated
;
118 struct memcached_server_st
{
119 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
122 unsigned int stack_responses
;
123 unsigned int cursor_active
;
124 char write_buffer
[MEMCACHED_MAX_BUFFER
];
125 size_t write_buffer_offset
;
127 char read_buffer
[MEMCACHED_MAX_BUFFER
];
128 size_t read_data_length
;
129 size_t read_buffer_length
;
131 memcached_allocated sockaddr_inited
;
132 struct addrinfo
*address_info
;
133 memcached_connection type
;
134 uint8_t major_version
;
135 uint8_t minor_version
;
136 uint8_t micro_version
;
140 struct memcached_stat_st
{
145 uint32_t pointer_size
;
146 uint32_t rusage_user_seconds
;
147 uint32_t rusage_user_microseconds
;
148 uint32_t rusage_system_seconds
;
149 uint32_t rusage_system_microseconds
;
151 uint32_t total_items
;
152 uint32_t limit_maxbytes
;
153 uint32_t curr_connections
;
154 uint32_t total_connections
;
155 uint32_t connection_structures
;
163 uint64_t bytes_written
;
164 char version
[MEMCACHED_VERSION_STRING
];
167 struct memcached_string_st
{
169 memcached_allocated is_allocated
;
176 struct memcached_result_st
{
177 memcached_allocated is_allocated
;
179 char key
[MEMCACHED_MAX_KEY
];
181 memcached_string_st value
;
186 struct memcached_st
{
187 memcached_allocated is_allocated
;
188 memcached_server_st
*hosts
;
189 unsigned int number_of_hosts
;
190 unsigned int cursor_server
;
193 unsigned long long flags
;
196 int32_t poll_timeout
;
197 memcached_string_st result_buffer
;
199 memcached_server_distribution distribution
;
200 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
202 memcached_return warning
; /* Future Use */
206 memcached_st
*memcached_create(memcached_st
*ptr
);
207 void memcached_free(memcached_st
*ptr
);
208 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
210 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
212 memcached_return
memcached_increment(memcached_st
*ptr
,
213 char *key
, size_t key_length
,
216 memcached_return
memcached_decrement(memcached_st
*ptr
,
217 char *key
, size_t key_length
,
220 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
221 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
222 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
223 char *hostname
, unsigned int port
);
224 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
225 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
226 void memcached_quit(memcached_st
*ptr
);
227 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
228 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
229 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
231 /* All of the functions for adding data to the server */
232 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
233 char *value
, size_t value_length
,
236 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
237 char *value
, size_t value_length
,
240 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
241 char *value
, size_t value_length
,
244 memcached_return
memcached_append(memcached_st
*ptr
,
245 char *key
, size_t key_length
,
246 char *value
, size_t value_length
,
249 memcached_return
memcached_prepend(memcached_st
*ptr
,
250 char *key
, size_t key_length
,
251 char *value
, size_t value_length
,
254 memcached_return
memcached_cas(memcached_st
*ptr
,
255 char *key
, size_t key_length
,
256 char *value
, size_t value_length
,
262 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
263 size_t *value_length
,
265 memcached_return
*error
);
266 memcached_return
memcached_mget(memcached_st
*ptr
,
267 char **keys
, size_t *key_length
,
268 unsigned int number_of_keys
);
269 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
270 size_t *value_length
, uint16_t *flags
,
271 memcached_return
*error
);
272 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
273 memcached_result_st
*result
,
274 memcached_return
*error
);
276 /* Server Public functions */
277 #define memcached_server_count(A) (A)->number_of_hosts
278 #define memcached_server_name(A,B) (B).hostname
279 #define memcached_server_port(A,B) (B).port
280 #define memcached_server_list(A) (A)->hosts
281 #define memcached_server_response_count(A,B) (A)->hosts[B].stack_responses
283 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
286 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
288 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
290 void memcached_server_list_free(memcached_server_st
*ptr
);
291 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
293 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
294 char *hostname
, unsigned int port
,
295 memcached_return
*error
);
296 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
297 memcached_server_st
*memcached_servers_parse(char *server_strings
);
299 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
300 char *key
, memcached_return
*error
);
301 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
302 memcached_return
*error
);
304 char *memcached_get_by_key(memcached_st
*ptr
,
305 char *master_key
, size_t master_key_length
,
306 char *key
, size_t key_length
,
307 size_t *value_length
,
309 memcached_return
*error
);
311 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
312 char *master_key
, size_t master_key_length
,
313 char **keys
, size_t *key_length
,
314 unsigned int number_of_keys
);
316 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
317 char *master_key
, size_t master_key_length
,
318 char *key
, size_t key_length
,
319 char *value
, size_t value_length
,
323 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
324 char *master_key
, size_t master_key_length
,
325 char *key
, size_t key_length
,
326 char *value
, size_t value_length
,
330 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
331 char *master_key
, size_t master_key_length
,
332 char *key
, size_t key_length
,
333 char *value
, size_t value_length
,
337 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
338 char *master_key
, size_t master_key_length
,
339 char *key
, size_t key_length
,
340 char *value
, size_t value_length
,
344 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
345 char *master_key
, size_t master_key_length
,
346 char *key
, size_t key_length
,
347 char *value
, size_t value_length
,
351 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
352 char *master_key
, size_t master_key_length
,
353 char *key
, size_t key_length
,
354 char *value
, size_t value_length
,
358 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
359 char *master_key
, size_t master_key_length
,
360 char *key
, size_t key_length
,
364 void memcached_result_free(memcached_result_st
*result
);
365 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
366 memcached_result_st
*result
);
367 #define memcached_result_key_value(A) A->key
368 #define memcached_result_key_length(A) A->key_length
370 #define memcached_result_value(A) memcached_string_value(A->value)
371 #define memcached_result_length(A) memcached_string_length(A->value)
373 char *memcached_result_value(memcached_result_st
*ptr
);
374 size_t memcached_result_length(memcached_result_st
*ptr
);
376 #define memcached_result_flags(A) A->flags
377 #define memcached_result_cas(A) A->cas
380 #ifndef __WATCHPOINT_H__
381 #define __WATCHPOINT_H__
382 /* Some personal debugging functions */
384 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
385 #ifdef __MEMCACHED_H__
386 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
387 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
389 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
390 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
391 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
392 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
393 #define WATCHPOINT_ASSERT(A) assert((A));
396 #ifdef __MEMCACHED_H__
397 #define WATCHPOINT_ERROR(A)
398 #define WATCHPOINT_IFERROR(A)
400 #define WATCHPOINT_STRING(A)
401 #define WATCHPOINT_NUMBER(A)
402 #define WATCHPOINT_ERRNO(A)
403 #define WATCHPOINT_ASSERT(A)
406 #endif /* __WATCHPOINT_H__ */
413 #endif /* __MEMCACHED_H__ */