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
39 MEMCACHED_HOST_LOOKUP_FAILURE
,
40 MEMCACHED_CONNECTION_FAILURE
,
41 MEMCACHED_CONNECTION_BIND_FAILURE
,
42 MEMCACHED_WRITE_FAILURE
,
43 MEMCACHED_READ_FAILURE
,
44 MEMCACHED_UNKNOWN_READ_FAILURE
,
45 MEMCACHED_PROTOCOL_ERROR
,
46 MEMCACHED_CLIENT_ERROR
,
47 MEMCACHED_SERVER_ERROR
,
48 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
49 MEMCACHED_DATA_EXISTS
,
50 MEMCACHED_DATA_DOES_NOT_EXIST
,
54 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
55 MEMCACHED_PARTIAL_READ
,
56 MEMCACHED_SOME_ERRORS
,
63 MEMCACHED_FAIL_UNIX_SOCKET
,
64 MEMCACHED_NOT_SUPPORTED
,
65 MEMCACHED_NO_KEY_PROVIDED
,
66 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
70 MEMCACHED_BEHAVIOR_NO_BLOCK
,
71 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
72 MEMCACHED_BEHAVIOR_HASH
,
73 MEMCACHED_BEHAVIOR_KETAMA
,
74 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
75 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
76 MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
,
77 MEMCACHED_BEHAVIOR_SUPPORT_CAS
,
78 MEMCACHED_BEHAVIOR_POLL_TIMEOUT
,
82 MEMCACHED_HASH_DEFAULT
= 0,
85 MEMCACHED_HASH_FNV1_64
,
86 MEMCACHED_HASH_FNV1A_64
,
87 MEMCACHED_HASH_FNV1_32
,
88 MEMCACHED_HASH_FNV1A_32
,
89 MEMCACHED_HASH_KETAMA
,
94 MEMCACHED_CONNECTION_UNKNOWN
,
95 MEMCACHED_CONNECTION_TCP
,
96 MEMCACHED_CONNECTION_UDP
,
97 MEMCACHED_CONNECTION_UNIX_SOCKET
,
98 } memcached_connection
;
101 MEMCACHED_NOT_ALLOCATED
,
104 } memcached_allocated
;
106 struct memcached_server_st
{
110 unsigned int stack_responses
;
111 unsigned int cursor_active
;
112 char write_buffer
[MEMCACHED_MAX_BUFFER
];
113 size_t write_buffer_offset
;
115 char read_buffer
[MEMCACHED_MAX_BUFFER
];
116 size_t read_buffer_length
;
118 memcached_allocated sockaddr_inited
;
119 struct sockaddr_in servAddr
;
120 memcached_connection type
;
121 uint8_t major_version
;
122 uint8_t minor_version
;
123 uint8_t micro_version
;
127 struct memcached_stat_st
{
132 uint32_t pointer_size
;
133 uint32_t rusage_user_seconds
;
134 uint32_t rusage_user_microseconds
;
135 uint32_t rusage_system_seconds
;
136 uint32_t rusage_system_microseconds
;
138 uint32_t total_items
;
139 uint32_t limit_maxbytes
;
140 uint32_t curr_connections
;
141 uint32_t total_connections
;
142 uint32_t connection_structures
;
150 uint64_t bytes_written
;
151 char version
[MEMCACHED_VERSION_STRING
];
154 struct memcached_string_st
{
156 memcached_allocated is_allocated
;
163 struct memcached_result_st
{
164 memcached_allocated is_allocated
;
166 char key
[MEMCACHED_MAX_KEY
];
168 memcached_string_st value
;
173 struct memcached_st
{
174 memcached_allocated is_allocated
;
175 memcached_server_st
*hosts
;
176 unsigned int number_of_hosts
;
177 unsigned int cursor_server
;
180 unsigned long long flags
;
183 int32_t poll_timeout
;
184 memcached_string_st result_buffer
;
186 memcached_return warning
; /* Future Use */
190 memcached_st
*memcached_create(memcached_st
*ptr
);
191 void memcached_free(memcached_st
*ptr
);
192 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
194 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
196 memcached_return
memcached_increment(memcached_st
*ptr
,
197 char *key
, size_t key_length
,
200 memcached_return
memcached_decrement(memcached_st
*ptr
,
201 char *key
, size_t key_length
,
204 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
205 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
206 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
207 char *hostname
, unsigned int port
);
208 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
209 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
210 void memcached_quit(memcached_st
*ptr
);
211 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
212 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
213 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
215 /* All of the functions for adding data to the server */
216 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
217 char *value
, size_t value_length
,
220 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
221 char *value
, size_t value_length
,
224 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
225 char *value
, size_t value_length
,
228 memcached_return
memcached_append(memcached_st
*ptr
,
229 char *key
, size_t key_length
,
230 char *value
, size_t value_length
,
233 memcached_return
memcached_prepend(memcached_st
*ptr
,
234 char *key
, size_t key_length
,
235 char *value
, size_t value_length
,
238 memcached_return
memcached_cas(memcached_st
*ptr
,
239 char *key
, size_t key_length
,
240 char *value
, size_t value_length
,
246 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
247 size_t *value_length
,
249 memcached_return
*error
);
250 memcached_return
memcached_mget(memcached_st
*ptr
,
251 char **keys
, size_t *key_length
,
252 unsigned int number_of_keys
);
253 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
254 size_t *value_length
, uint16_t *flags
,
255 memcached_return
*error
);
256 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
257 memcached_result_st
*result
,
258 memcached_return
*error
);
260 /* Server Public functions */
261 #define memcached_server_count(A) (A)->number_of_hosts
262 #define memcached_server_name(A,B) (B).hostname
263 #define memcached_server_port(A,B) (B).port
264 #define memcached_server_list(A) (A)->hosts
265 #define memcached_server_response_count(A,B) (A)->hosts[B].stack_responses
267 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
270 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
272 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
274 void memcached_server_list_free(memcached_server_st
*ptr
);
275 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
277 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
278 char *hostname
, unsigned int port
,
279 memcached_return
*error
);
280 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
281 memcached_server_st
*memcached_servers_parse(char *server_strings
);
283 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
284 char *key
, memcached_return
*error
);
285 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
286 memcached_return
*error
);
289 void memcached_result_free(memcached_result_st
*result
);
290 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
291 memcached_result_st
*result
);
292 #define memcached_result_key_value(A) A->key
293 #define memcached_result_key_length(A) A->key_length
295 #define memcached_result_value(A) memcached_string_value(A->value)
296 #define memcached_result_length(A) memcached_string_length(A->value)
298 char *memcached_result_value(memcached_result_st
*ptr
);
299 size_t memcached_result_length(memcached_result_st
*ptr
);
301 #define memcached_result_flags(A) A->flags
302 #define memcached_result_cas(A) A->cas
305 #ifndef __WATCHPOINT_H__
306 #define __WATCHPOINT_H__
307 /* Some personal debugging functions */
309 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
310 #ifdef __MEMCACHED_H__
311 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
313 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
314 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
315 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
316 #define WATCHPOINT_ASSERT(A) assert((A));
319 #define WATCHPOINT { 1; };
320 #define WATCHPOINT_ERROR(A) { 1; };
321 #define WATCHPOINT_STRING(A) { 1; };
322 #define WATCHPOINT_NUMBER(A) { 1; };
323 #define WATCHPOINT_ERRNO(A) { 1; };
324 #define WATCHPOINT_ASSERT(A) { 1; };
327 #ifdef __MEMCACHED_H__
328 #define WATCHPOINT_ERROR(A)
330 #define WATCHPOINT_STRING(A)
331 #define WATCHPOINT_NUMBER(A)
332 #define WATCHPOINT_ERRNO(A)
333 #define WATCHPOINT_ASSERT(A)
336 #endif /* __WATCHPOINT_H__ */
343 #endif /* __MEMCACHED_H__ */