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>
21 typedef struct memcached_st memcached_st
;
22 typedef struct memcached_stat_st memcached_stat_st
;
23 typedef struct memcached_result_st memcached_result_st
;
24 typedef struct memcached_string_st memcached_string_st
;
25 typedef struct memcached_server_st memcached_server_st
;
27 #define MEMCACHED_DEFAULT_PORT 11211
28 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
29 #define SMALL_STRING_LEN 1024
30 #define HUGE_STRING_LEN 8196
31 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
32 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
37 MEMCACHED_HOST_LOCKUP_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_MAXIMUM_RETURN
, /* Always add new error code before */
68 MEMCACHED_BEHAVIOR_NO_BLOCK
,
69 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
70 MEMCACHED_BEHAVIOR_HASH
,
71 MEMCACHED_BEHAVIOR_KETAMA
,
72 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
73 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
77 MEMCACHED_HASH_DEFAULT
= 0,
80 MEMCACHED_HASH_FNV1_64
,
81 MEMCACHED_HASH_FNV1A_64
,
82 MEMCACHED_HASH_FNV1_32
,
83 MEMCACHED_HASH_FNV1A_32
,
84 MEMCACHED_HASH_KETAMA
,
88 MEMCACHED_CONNECTION_UNKNOWN
,
89 MEMCACHED_CONNECTION_TCP
,
90 MEMCACHED_CONNECTION_UDP
,
91 MEMCACHED_CONNECTION_UNIX_SOCKET
,
92 } memcached_connection
;
95 MEMCACHED_NOT_ALLOCATED
,
97 } memcached_allocated
;
99 struct memcached_server_st
{
103 unsigned int stack_responses
;
104 unsigned int cursor_active
;
105 char write_buffer
[MEMCACHED_MAX_BUFFER
];
106 size_t write_buffer_offset
;
107 char read_buffer
[MEMCACHED_MAX_BUFFER
];
108 size_t read_buffer_length
;
110 memcached_connection type
;
113 struct memcached_stat_st
{
116 unsigned int threads
;
119 unsigned int pointer_size
;
120 unsigned int rusage_user
;
121 unsigned int rusage_system
;
122 unsigned int rusage_user_seconds
;
123 unsigned int rusage_user_microseconds
;
124 unsigned int rusage_system_seconds
;
125 unsigned int rusage_system_microseconds
;
126 unsigned int curr_items
;
127 unsigned int total_items
;
128 unsigned long long bytes
;
129 unsigned int curr_connections
;
130 unsigned int total_connections
;
131 unsigned int connection_structures
;
132 unsigned long long cmd_get
;
133 unsigned long long cmd_set
;
134 unsigned long long get_hits
;
135 unsigned long long get_misses
;
136 unsigned long long evictions
;
137 unsigned long long bytes_read
;
138 unsigned long long bytes_written
;
139 unsigned int limit_maxbytes
;
142 struct memcached_string_st
{
144 memcached_allocated is_allocated
;
151 struct memcached_result_st
{
152 memcached_allocated is_allocated
;
154 char key
[MEMCACHED_MAX_KEY
];
156 memcached_string_st value
;
161 struct memcached_st
{
162 memcached_allocated is_allocated
;
163 memcached_server_st
*hosts
;
164 unsigned int number_of_hosts
;
165 unsigned int cursor_server
;
168 unsigned long long flags
;
171 memcached_string_st result_buffer
;
173 memcached_return warning
; /* Future Use */
177 memcached_st
*memcached_create(memcached_st
*ptr
);
178 void memcached_free(memcached_st
*ptr
);
179 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
181 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
183 memcached_return
memcached_increment(memcached_st
*ptr
,
184 char *key
, size_t key_length
,
187 memcached_return
memcached_decrement(memcached_st
*ptr
,
188 char *key
, size_t key_length
,
191 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
192 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
193 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
194 char *hostname
, unsigned int port
);
195 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
196 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
197 void memcached_quit(memcached_st
*ptr
);
198 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
199 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
200 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
202 /* All of the functions for adding data to the server */
203 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
204 char *value
, size_t value_length
,
207 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
208 char *value
, size_t value_length
,
211 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
212 char *value
, size_t value_length
,
217 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
218 size_t *value_length
,
220 memcached_return
*error
);
221 memcached_return
memcached_mget(memcached_st
*ptr
,
222 char **keys
, size_t *key_length
,
223 unsigned int number_of_keys
);
224 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
225 size_t *value_length
, uint16_t *flags
,
226 memcached_return
*error
);
227 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
228 memcached_result_st
*result
,
229 memcached_return
*error
);
231 /* Server Public functions */
232 #define memcached_server_count(A) A->number_of_hosts
233 #define memcached_server_name(A,B) B.hostname
234 #define memcached_server_port(A,B) B.port
235 #define memcached_server_list(A) A->hosts
236 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
238 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
240 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
242 void memcached_server_list_free(memcached_server_st
*ptr
);
243 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
245 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
246 char *hostname
, unsigned int port
,
247 memcached_return
*error
);
248 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
249 memcached_server_st
*memcached_servers_parse(char *server_strings
);
251 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
252 char *key
, memcached_return
*error
);
253 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
254 memcached_return
*error
);
257 void memcached_result_free(memcached_result_st
*result
);
258 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
259 memcached_result_st
*result
);
260 #define memcached_result_key_value(A) A->key
261 #define memcached_result_key_length(A) A->key_length
263 #define memcached_result_value(A) memcached_string_value(A->value)
264 #define memcached_result_length(A) memcached_string_length(A->value)
266 char *memcached_result_value(memcached_result_st
*ptr
);
267 size_t memcached_result_length(memcached_result_st
*ptr
);
269 #define memcached_result_flags(A) A->flags
270 #define memcached_result_cas(A) A->cas
273 #ifndef __WATCHPOINT_H__
274 #define __WATCHPOINT_H__
275 /* Some personal debugging functions */
277 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
278 #ifdef __MEMCACHED_H__
279 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
281 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
282 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
283 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
284 #define WATCHPOINT_ASSERT(A) assert((A));
287 #define WATCHPOINT { 1; };
288 #define WATCHPOINT_ERROR(A) { 1; };
289 #define WATCHPOINT_STRING(A) { 1; };
290 #define WATCHPOINT_NUMBER(A) { 1; };
291 #define WATCHPOINT_ERRNO(A) { 1; };
292 #define WATCHPOINT_ASSERT(A) { 1; };
295 #ifdef __MEMCACHED_H__
296 #define WATCHPOINT_ERROR(A)
298 #define WATCHPOINT_STRING(A)
299 #define WATCHPOINT_NUMBER(A)
300 #define WATCHPOINT_ERRNO(A)
301 #define WATCHPOINT_ASSERT(A)
304 #endif /* __WATCHPOINT_H__ */
311 #endif /* __MEMCACHED_H__ */