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 /* These are Private and should not be used by applications */
29 #define SMALL_STRING_LEN 1024
30 #define HUGE_STRING_LEN 8196
32 #define MEMCACHED_VERSION_STRING 12
33 #define MEMCACHED_DEFAULT_PORT 11211
34 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
35 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
36 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
37 #define MEMCACHED_MAX_HOST_LENGTH 64
38 #define MEMCACHED_WHEEL_SIZE 1024
39 #define MEMCACHED_STRIDE 4
40 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
45 MEMCACHED_HOST_LOOKUP_FAILURE
,
46 MEMCACHED_CONNECTION_FAILURE
,
47 MEMCACHED_CONNECTION_BIND_FAILURE
,
48 MEMCACHED_WRITE_FAILURE
,
49 MEMCACHED_READ_FAILURE
,
50 MEMCACHED_UNKNOWN_READ_FAILURE
,
51 MEMCACHED_PROTOCOL_ERROR
,
52 MEMCACHED_CLIENT_ERROR
,
53 MEMCACHED_SERVER_ERROR
,
54 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
55 MEMCACHED_DATA_EXISTS
,
56 MEMCACHED_DATA_DOES_NOT_EXIST
,
60 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
61 MEMCACHED_PARTIAL_READ
,
62 MEMCACHED_SOME_ERRORS
,
69 MEMCACHED_FAIL_UNIX_SOCKET
,
70 MEMCACHED_NOT_SUPPORTED
,
71 MEMCACHED_NO_KEY_PROVIDED
,
72 MEMCACHED_FETCH_NOTFINISHED
,
75 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
79 MEMCACHED_DISTRIBUTION_MODULA
,
80 MEMCACHED_DISTRIBUTION_CONSISTENT
,
81 } memcached_server_distribution
;
84 MEMCACHED_BEHAVIOR_NO_BLOCK
,
85 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
86 MEMCACHED_BEHAVIOR_HASH
,
87 MEMCACHED_BEHAVIOR_KETAMA
,
88 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
89 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
90 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
91 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
92 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
93 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
94 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
95 MEMCACHED_BEHAVIOR_USER_DATA
,
99 MEMCACHED_HASH_DEFAULT
= 0,
102 MEMCACHED_HASH_FNV1_64
,
103 MEMCACHED_HASH_FNV1A_64
,
104 MEMCACHED_HASH_FNV1_32
,
105 MEMCACHED_HASH_FNV1A_32
,
106 MEMCACHED_HASH_KETAMA
,
107 MEMCACHED_HASH_HSIEH
,
111 MEMCACHED_CONNECTION_UNKNOWN
,
112 MEMCACHED_CONNECTION_TCP
,
113 MEMCACHED_CONNECTION_UDP
,
114 MEMCACHED_CONNECTION_UNIX_SOCKET
,
115 } memcached_connection
;
118 MEMCACHED_NOT_ALLOCATED
,
121 } memcached_allocated
;
123 struct memcached_server_st
{
124 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
127 unsigned int cursor_active
;
128 char write_buffer
[MEMCACHED_MAX_BUFFER
];
129 size_t write_buffer_offset
;
131 char read_buffer
[MEMCACHED_MAX_BUFFER
];
132 size_t read_data_length
;
133 size_t read_buffer_length
;
135 memcached_allocated sockaddr_inited
;
136 struct addrinfo
*address_info
;
137 memcached_connection type
;
138 uint8_t major_version
;
139 uint8_t minor_version
;
140 uint8_t micro_version
;
144 struct memcached_stat_st
{
149 uint32_t pointer_size
;
150 uint32_t rusage_user_seconds
;
151 uint32_t rusage_user_microseconds
;
152 uint32_t rusage_system_seconds
;
153 uint32_t rusage_system_microseconds
;
155 uint32_t total_items
;
156 uint32_t limit_maxbytes
;
157 uint32_t curr_connections
;
158 uint32_t total_connections
;
159 uint32_t connection_structures
;
167 uint64_t bytes_written
;
168 char version
[MEMCACHED_VERSION_STRING
];
171 struct memcached_string_st
{
173 memcached_allocated is_allocated
;
180 struct memcached_result_st
{
181 memcached_allocated is_allocated
;
183 char key
[MEMCACHED_MAX_KEY
];
185 memcached_string_st value
;
188 /* Add result callback function */
191 struct memcached_st
{
192 memcached_allocated is_allocated
;
193 memcached_server_st
*hosts
;
194 unsigned int number_of_hosts
;
195 unsigned int cursor_server
;
198 unsigned long long flags
;
201 int32_t poll_timeout
;
202 memcached_result_st result
;
204 memcached_server_distribution distribution
;
206 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
207 #ifdef NOT_USED /* Future Use */
209 memcached_return warning
;
214 memcached_st
*memcached_create(memcached_st
*ptr
);
215 void memcached_free(memcached_st
*ptr
);
216 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
218 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
220 memcached_return
memcached_increment(memcached_st
*ptr
,
221 char *key
, size_t key_length
,
224 memcached_return
memcached_decrement(memcached_st
*ptr
,
225 char *key
, size_t key_length
,
228 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
229 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
230 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
231 char *hostname
, unsigned int port
);
232 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
233 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
234 void memcached_quit(memcached_st
*ptr
);
235 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
236 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
237 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
239 /* All of the functions for adding data to the server */
240 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
241 char *value
, size_t value_length
,
244 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
245 char *value
, size_t value_length
,
248 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
249 char *value
, size_t value_length
,
252 memcached_return
memcached_append(memcached_st
*ptr
,
253 char *key
, size_t key_length
,
254 char *value
, size_t value_length
,
257 memcached_return
memcached_prepend(memcached_st
*ptr
,
258 char *key
, size_t key_length
,
259 char *value
, size_t value_length
,
262 memcached_return
memcached_cas(memcached_st
*ptr
,
263 char *key
, size_t key_length
,
264 char *value
, size_t value_length
,
270 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
271 size_t *value_length
,
273 memcached_return
*error
);
274 memcached_return
memcached_mget(memcached_st
*ptr
,
275 char **keys
, size_t *key_length
,
276 unsigned int number_of_keys
);
277 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
278 size_t *value_length
, uint32_t *flags
,
279 memcached_return
*error
);
280 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
281 memcached_result_st
*result
,
282 memcached_return
*error
);
284 /* Server Public functions */
285 #define memcached_server_count(A) (A)->number_of_hosts
286 #define memcached_server_name(A,B) (B).hostname
287 #define memcached_server_port(A,B) (B).port
288 #define memcached_server_list(A) (A)->hosts
289 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
291 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
294 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
296 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
298 void memcached_server_list_free(memcached_server_st
*ptr
);
299 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
301 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
302 char *hostname
, unsigned int port
,
303 memcached_return
*error
);
304 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
305 memcached_server_st
*memcached_servers_parse(char *server_strings
);
307 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
308 char *key
, memcached_return
*error
);
309 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
310 memcached_return
*error
);
312 char *memcached_get_by_key(memcached_st
*ptr
,
313 char *master_key
, size_t master_key_length
,
314 char *key
, size_t key_length
,
315 size_t *value_length
,
317 memcached_return
*error
);
319 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
320 char *master_key
, size_t master_key_length
,
321 char **keys
, size_t *key_length
,
322 unsigned int number_of_keys
);
324 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
325 char *master_key
, size_t master_key_length
,
326 char *key
, size_t key_length
,
327 char *value
, size_t value_length
,
331 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
332 char *master_key
, size_t master_key_length
,
333 char *key
, size_t key_length
,
334 char *value
, size_t value_length
,
338 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
339 char *master_key
, size_t master_key_length
,
340 char *key
, size_t key_length
,
341 char *value
, size_t value_length
,
345 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
346 char *master_key
, size_t master_key_length
,
347 char *key
, size_t key_length
,
348 char *value
, size_t value_length
,
352 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
353 char *master_key
, size_t master_key_length
,
354 char *key
, size_t key_length
,
355 char *value
, size_t value_length
,
359 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
360 char *master_key
, size_t master_key_length
,
361 char *key
, size_t key_length
,
362 char *value
, size_t value_length
,
366 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
367 char *master_key
, size_t master_key_length
,
368 char *key
, size_t key_length
,
371 memcached_return
memcached_mdelete(memcached_st
*ptr
,
372 char **key
, size_t *key_length
,
373 unsigned int number_of_keys
,
376 memcached_return
memcached_mdelete_by_key(memcached_st
*ptr
,
377 char *master_key
, size_t master_key_length
,
378 char **key
, size_t *key_length
,
379 unsigned int number_of_keys
,
382 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
383 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
385 unsigned int number_of_callbacks
389 void memcached_result_free(memcached_result_st
*result
);
390 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
391 memcached_result_st
*result
);
392 #define memcached_result_key_value(A) (A)->key
393 #define memcached_result_key_length(A) (A)->key_length
395 #define memcached_result_value(A) memcached_string_value((A)->value)
396 #define memcached_result_length(A) memcached_string_length((A)->value)
398 char *memcached_result_value(memcached_result_st
*ptr
);
399 size_t memcached_result_length(memcached_result_st
*ptr
);
401 #define memcached_result_flags(A) (A)->flags
402 #define memcached_result_cas(A) (A)->cas
405 #ifndef __WATCHPOINT_H__
406 #define __WATCHPOINT_H__
407 /* Some personal debugging functions */
409 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
410 #ifdef __MEMCACHED_H__
411 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
412 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
414 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
415 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
416 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
417 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
418 #define WATCHPOINT_ASSERT(A) assert((A));
421 #ifdef __MEMCACHED_H__
422 #define WATCHPOINT_ERROR(A)
423 #define WATCHPOINT_IFERROR(A)
425 #define WATCHPOINT_STRING(A)
426 #define WATCHPOINT_NUMBER(A)
427 #define WATCHPOINT_ERRNO(A)
428 #define WATCHPOINT_ASSERT(A)
431 #endif /* __WATCHPOINT_H__ */
438 #endif /* __MEMCACHED_H__ */