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
,
73 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
77 MEMCACHED_DISTRIBUTION_MODULA
,
78 MEMCACHED_DISTRIBUTION_CONSISTENT
,
79 } memcached_server_distribution
;
82 MEMCACHED_BEHAVIOR_NO_BLOCK
,
83 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
84 MEMCACHED_BEHAVIOR_HASH
,
85 MEMCACHED_BEHAVIOR_KETAMA
,
86 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
87 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
88 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
89 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
90 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
91 MEMCACHED_BEHAVIOR_DISTRIBUTION
,
92 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
,
93 MEMCACHED_BEHAVIOR_USER_DATA
,
97 MEMCACHED_HASH_DEFAULT
= 0,
100 MEMCACHED_HASH_FNV1_64
,
101 MEMCACHED_HASH_FNV1A_64
,
102 MEMCACHED_HASH_FNV1_32
,
103 MEMCACHED_HASH_FNV1A_32
,
104 MEMCACHED_HASH_KETAMA
,
105 MEMCACHED_HASH_HSIEH
,
109 MEMCACHED_CONNECTION_UNKNOWN
,
110 MEMCACHED_CONNECTION_TCP
,
111 MEMCACHED_CONNECTION_UDP
,
112 MEMCACHED_CONNECTION_UNIX_SOCKET
,
113 } memcached_connection
;
116 MEMCACHED_NOT_ALLOCATED
,
119 } memcached_allocated
;
121 struct memcached_server_st
{
122 char hostname
[MEMCACHED_MAX_HOST_LENGTH
];
125 unsigned int cursor_active
;
126 char write_buffer
[MEMCACHED_MAX_BUFFER
];
127 size_t write_buffer_offset
;
129 char read_buffer
[MEMCACHED_MAX_BUFFER
];
130 size_t read_data_length
;
131 size_t read_buffer_length
;
133 memcached_allocated sockaddr_inited
;
134 struct addrinfo
*address_info
;
135 memcached_connection type
;
136 uint8_t major_version
;
137 uint8_t minor_version
;
138 uint8_t micro_version
;
142 struct memcached_stat_st
{
147 uint32_t pointer_size
;
148 uint32_t rusage_user_seconds
;
149 uint32_t rusage_user_microseconds
;
150 uint32_t rusage_system_seconds
;
151 uint32_t rusage_system_microseconds
;
153 uint32_t total_items
;
154 uint32_t limit_maxbytes
;
155 uint32_t curr_connections
;
156 uint32_t total_connections
;
157 uint32_t connection_structures
;
165 uint64_t bytes_written
;
166 char version
[MEMCACHED_VERSION_STRING
];
169 struct memcached_string_st
{
171 memcached_allocated is_allocated
;
178 struct memcached_result_st
{
179 memcached_allocated is_allocated
;
181 char key
[MEMCACHED_MAX_KEY
];
183 memcached_string_st value
;
186 /* Add result callback function */
189 struct memcached_st
{
190 memcached_allocated is_allocated
;
191 memcached_server_st
*hosts
;
192 unsigned int number_of_hosts
;
193 unsigned int cursor_server
;
196 unsigned long long flags
;
199 int32_t poll_timeout
;
200 memcached_result_st result
;
202 memcached_server_distribution distribution
;
204 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
205 #ifdef NOT_USED /* Future Use */
207 memcached_return warning
;
212 memcached_st
*memcached_create(memcached_st
*ptr
);
213 void memcached_free(memcached_st
*ptr
);
214 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
216 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
218 memcached_return
memcached_increment(memcached_st
*ptr
,
219 char *key
, size_t key_length
,
222 memcached_return
memcached_decrement(memcached_st
*ptr
,
223 char *key
, size_t key_length
,
226 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
227 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
228 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
229 char *hostname
, unsigned int port
);
230 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
231 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
232 void memcached_quit(memcached_st
*ptr
);
233 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
234 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
235 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
237 /* All of the functions for adding data to the server */
238 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
239 char *value
, size_t value_length
,
242 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
243 char *value
, size_t value_length
,
246 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
247 char *value
, size_t value_length
,
250 memcached_return
memcached_append(memcached_st
*ptr
,
251 char *key
, size_t key_length
,
252 char *value
, size_t value_length
,
255 memcached_return
memcached_prepend(memcached_st
*ptr
,
256 char *key
, size_t key_length
,
257 char *value
, size_t value_length
,
260 memcached_return
memcached_cas(memcached_st
*ptr
,
261 char *key
, size_t key_length
,
262 char *value
, size_t value_length
,
268 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
269 size_t *value_length
,
271 memcached_return
*error
);
272 memcached_return
memcached_mget(memcached_st
*ptr
,
273 char **keys
, size_t *key_length
,
274 unsigned int number_of_keys
);
275 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
276 size_t *value_length
, uint32_t *flags
,
277 memcached_return
*error
);
278 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
279 memcached_result_st
*result
,
280 memcached_return
*error
);
282 /* Server Public functions */
283 #define memcached_server_count(A) (A)->number_of_hosts
284 #define memcached_server_name(A,B) (B).hostname
285 #define memcached_server_port(A,B) (B).port
286 #define memcached_server_list(A) (A)->hosts
287 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
289 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
292 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
294 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
296 void memcached_server_list_free(memcached_server_st
*ptr
);
297 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
299 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
300 char *hostname
, unsigned int port
,
301 memcached_return
*error
);
302 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
303 memcached_server_st
*memcached_servers_parse(char *server_strings
);
305 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
306 char *key
, memcached_return
*error
);
307 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
308 memcached_return
*error
);
310 char *memcached_get_by_key(memcached_st
*ptr
,
311 char *master_key
, size_t master_key_length
,
312 char *key
, size_t key_length
,
313 size_t *value_length
,
315 memcached_return
*error
);
317 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
318 char *master_key
, size_t master_key_length
,
319 char **keys
, size_t *key_length
,
320 unsigned int number_of_keys
);
322 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
323 char *master_key
, size_t master_key_length
,
324 char *key
, size_t key_length
,
325 char *value
, size_t value_length
,
329 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
330 char *master_key
, size_t master_key_length
,
331 char *key
, size_t key_length
,
332 char *value
, size_t value_length
,
336 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
337 char *master_key
, size_t master_key_length
,
338 char *key
, size_t key_length
,
339 char *value
, size_t value_length
,
343 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
344 char *master_key
, size_t master_key_length
,
345 char *key
, size_t key_length
,
346 char *value
, size_t value_length
,
350 memcached_return
memcached_append_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_cas_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_delete_by_key(memcached_st
*ptr
,
365 char *master_key
, size_t master_key_length
,
366 char *key
, size_t key_length
,
369 memcached_return
memcached_mdelete(memcached_st
*ptr
,
370 char **key
, size_t *key_length
,
371 unsigned int number_of_keys
,
374 memcached_return
memcached_mdelete_by_key(memcached_st
*ptr
,
375 char *master_key
, size_t master_key_length
,
376 char **key
, size_t *key_length
,
377 unsigned int number_of_keys
,
380 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
381 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
383 unsigned int number_of_callbacks
387 void memcached_result_free(memcached_result_st
*result
);
388 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
389 memcached_result_st
*result
);
390 #define memcached_result_key_value(A) (A)->key
391 #define memcached_result_key_length(A) (A)->key_length
393 #define memcached_result_value(A) memcached_string_value((A)->value)
394 #define memcached_result_length(A) memcached_string_length((A)->value)
396 char *memcached_result_value(memcached_result_st
*ptr
);
397 size_t memcached_result_length(memcached_result_st
*ptr
);
399 #define memcached_result_flags(A) (A)->flags
400 #define memcached_result_cas(A) (A)->cas
403 #ifndef __WATCHPOINT_H__
404 #define __WATCHPOINT_H__
405 /* Some personal debugging functions */
407 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
408 #ifdef __MEMCACHED_H__
409 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
410 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
412 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
413 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
414 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
415 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
416 #define WATCHPOINT_ASSERT(A) assert((A));
419 #ifdef __MEMCACHED_H__
420 #define WATCHPOINT_ERROR(A)
421 #define WATCHPOINT_IFERROR(A)
423 #define WATCHPOINT_STRING(A)
424 #define WATCHPOINT_NUMBER(A)
425 #define WATCHPOINT_ERRNO(A)
426 #define WATCHPOINT_ASSERT(A)
429 #endif /* __WATCHPOINT_H__ */
436 #endif /* __MEMCACHED_H__ */