projects / awesomized / libmemcached / blob
? search:


1cbdcf683ae1e0e298d0a25d249078f5f2e38303
[awesomized/libmemcached] / include / memcached.h
1 /*
2 * Summary: interface for memcached server
3 * Description: main include file for libmemcached
4 *
5 * Copy: See Copyright for the status of this software.
6 *
7 * Author: Brian Aker
8 */
9
10 #ifndef __MEMCACHED_H__
11 #define __MEMCACHED_H__
12
13 #include <stdlib.h>
14 #include <inttypes.h>
15 #include <sys/types.h>
16 #include <netinet/in.h>
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
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;
27
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
39
40 typedef enum {
41 MEMCACHED_SUCCESS,
42 MEMCACHED_FAILURE,
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,
55 MEMCACHED_NOTSTORED,
56 MEMCACHED_STORED,
57 MEMCACHED_NOTFOUND,
58 MEMCACHED_MEMORY_ALLOCATION_FAILURE,
59 MEMCACHED_PARTIAL_READ,
60 MEMCACHED_SOME_ERRORS,
61 MEMCACHED_NO_SERVERS,
62 MEMCACHED_END,
63 MEMCACHED_DELETED,
64 MEMCACHED_VALUE,
65 MEMCACHED_STAT,
66 MEMCACHED_ERRNO,
67 MEMCACHED_FAIL_UNIX_SOCKET,
68 MEMCACHED_NOT_SUPPORTED,
69 MEMCACHED_NO_KEY_PROVIDED,
70 MEMCACHED_FETCH_NOTFINISHED,
71 MEMCACHED_TIMEOUT,
72 MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
73 } memcached_return;
74
75 typedef enum {
76 MEMCACHED_DISTRIBUTION_MODULA,
77 MEMCACHED_DISTRIBUTION_CONSISTENT,
78 } memcached_server_distribution;
79
80 typedef enum {
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,
91 } memcached_behavior;
92
93 typedef enum {
94 MEMCACHED_HASH_DEFAULT= 0,
95 MEMCACHED_HASH_MD5,
96 MEMCACHED_HASH_CRC,
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,
103 } memcached_hash;
104
105 typedef enum {
106 MEMCACHED_CONNECTION_UNKNOWN,
107 MEMCACHED_CONNECTION_TCP,
108 MEMCACHED_CONNECTION_UDP,
109 MEMCACHED_CONNECTION_UNIX_SOCKET,
110 } memcached_connection;
111
112 typedef enum {
113 MEMCACHED_NOT_ALLOCATED,
114 MEMCACHED_ALLOCATED,
115 MEMCACHED_USED,
116 } memcached_allocated;
117
118 struct memcached_server_st {
119 char hostname[MEMCACHED_MAX_HOST_LENGTH];
120 unsigned int port;
121 int fd;
122 unsigned int cursor_active;
123 char write_buffer[MEMCACHED_MAX_BUFFER];
124 size_t write_buffer_offset;
125 char *write_ptr;
126 char read_buffer[MEMCACHED_MAX_BUFFER];
127 size_t read_data_length;
128 size_t read_buffer_length;
129 char *read_ptr;
130 memcached_allocated sockaddr_inited;
131 struct addrinfo *address_info;
132 memcached_connection type;
133 uint8_t major_version;
134 uint8_t minor_version;
135 uint8_t micro_version;
136 uint16_t count;
137 };
138
139 struct memcached_stat_st {
140 uint32_t pid;
141 uint32_t uptime;
142 uint32_t threads;
143 uint32_t time;
144 uint32_t pointer_size;
145 uint32_t rusage_user_seconds;
146 uint32_t rusage_user_microseconds;
147 uint32_t rusage_system_seconds;
148 uint32_t rusage_system_microseconds;
149 uint32_t curr_items;
150 uint32_t total_items;
151 uint32_t limit_maxbytes;
152 uint32_t curr_connections;
153 uint32_t total_connections;
154 uint32_t connection_structures;
155 uint64_t bytes;
156 uint64_t cmd_get;
157 uint64_t cmd_set;
158 uint64_t get_hits;
159 uint64_t get_misses;
160 uint64_t evictions;
161 uint64_t bytes_read;
162 uint64_t bytes_written;
163 char version[MEMCACHED_VERSION_STRING];
164 };
165
166 struct memcached_string_st {
167 memcached_st *root;
168 memcached_allocated is_allocated;
169 char *string;
170 char *end;
171 size_t current_size;
172 size_t block_size;
173 };
174
175 struct memcached_result_st {
176 memcached_allocated is_allocated;
177 memcached_st *root;
178 char key[MEMCACHED_MAX_KEY];
179 size_t key_length;
180 memcached_string_st value;
181 uint32_t flags;
182 uint64_t cas;
183 /* Add result callback function */
184 };
185
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;
191 char connected;
192 int cached_errno;
193 unsigned long long flags;
194 int send_size;
195 int recv_size;
196 int32_t poll_timeout;
197 memcached_result_st result;
198 memcached_hash hash;
199 memcached_server_distribution distribution;
200 unsigned int wheel[MEMCACHED_WHEEL_SIZE];
201 #ifdef NOT_USED /* Future Use */
202 uint8_t replicas;
203 memcached_return warning;
204 #endif
205 };
206
207 /* Public API */
208 memcached_st *memcached_create(memcached_st *ptr);
209 void memcached_free(memcached_st *ptr);
210 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
211
212 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
213 time_t expiration);
214 memcached_return memcached_increment(memcached_st *ptr,
215 char *key, size_t key_length,
216 uint32_t offset,
217 uint64_t *value);
218 memcached_return memcached_decrement(memcached_st *ptr,
219 char *key, size_t key_length,
220 uint32_t offset,
221 uint64_t *value);
222 void memcached_stat_free(memcached_st *, memcached_stat_st *);
223 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
224 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
225 char *hostname, unsigned int port);
226 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
227 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
228 void memcached_quit(memcached_st *ptr);
229 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
230 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
231 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
232
233 /* All of the functions for adding data to the server */
234 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
235 char *value, size_t value_length,
236 time_t expiration,
237 uint32_t flags);
238 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
239 char *value, size_t value_length,
240 time_t expiration,
241 uint32_t flags);
242 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
243 char *value, size_t value_length,
244 time_t expiration,
245 uint32_t flags);
246 memcached_return memcached_append(memcached_st *ptr,
247 char *key, size_t key_length,
248 char *value, size_t value_length,
249 time_t expiration,
250 uint32_t flags);
251 memcached_return memcached_prepend(memcached_st *ptr,
252 char *key, size_t key_length,
253 char *value, size_t value_length,
254 time_t expiration,
255 uint32_t flags);
256 memcached_return memcached_cas(memcached_st *ptr,
257 char *key, size_t key_length,
258 char *value, size_t value_length,
259 time_t expiration,
260 uint32_t flags,
261 uint64_t cas);
262
263 /* Get functions */
264 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
265 size_t *value_length,
266 uint32_t *flags,
267 memcached_return *error);
268 memcached_return memcached_mget(memcached_st *ptr,
269 char **keys, size_t *key_length,
270 unsigned int number_of_keys);
271 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
272 size_t *value_length, uint32_t *flags,
273 memcached_return *error);
274 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
275 memcached_result_st *result,
276 memcached_return *error);
277
278 /* Server Public functions */
279 #define memcached_server_count(A) (A)->number_of_hosts
280 #define memcached_server_name(A,B) (B).hostname
281 #define memcached_server_port(A,B) (B).port
282 #define memcached_server_list(A) (A)->hosts
283 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
284
285 memcached_return memcached_server_add_udp(memcached_st *ptr,
286 char *hostname,
287 unsigned int port);
288 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
289 char *filename);
290 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
291 unsigned int port);
292 void memcached_server_list_free(memcached_server_st *ptr);
293 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
294
295 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
296 char *hostname, unsigned int port,
297 memcached_return *error);
298 unsigned int memcached_server_list_count(memcached_server_st *ptr);
299 memcached_server_st *memcached_servers_parse(char *server_strings);
300
301 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
302 char *key, memcached_return *error);
303 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
304 memcached_return *error);
305
306 char *memcached_get_by_key(memcached_st *ptr,
307 char *master_key, size_t master_key_length,
308 char *key, size_t key_length,
309 size_t *value_length,
310 uint32_t *flags,
311 memcached_return *error);
312
313 memcached_return memcached_mget_by_key(memcached_st *ptr,
314 char *master_key, size_t master_key_length,
315 char **keys, size_t *key_length,
316 unsigned int number_of_keys);
317
318 memcached_return memcached_set_by_key(memcached_st *ptr,
319 char *master_key, size_t master_key_length,
320 char *key, size_t key_length,
321 char *value, size_t value_length,
322 time_t expiration,
323 uint32_t flags);
324
325 memcached_return memcached_add_by_key(memcached_st *ptr,
326 char *master_key, size_t master_key_length,
327 char *key, size_t key_length,
328 char *value, size_t value_length,
329 time_t expiration,
330 uint32_t flags);
331
332 memcached_return memcached_replace_by_key(memcached_st *ptr,
333 char *master_key, size_t master_key_length,
334 char *key, size_t key_length,
335 char *value, size_t value_length,
336 time_t expiration,
337 uint32_t flags);
338
339 memcached_return memcached_prepend_by_key(memcached_st *ptr,
340 char *master_key, size_t master_key_length,
341 char *key, size_t key_length,
342 char *value, size_t value_length,
343 time_t expiration,
344 uint32_t flags);
345
346 memcached_return memcached_append_by_key(memcached_st *ptr,
347 char *master_key, size_t master_key_length,
348 char *key, size_t key_length,
349 char *value, size_t value_length,
350 time_t expiration,
351 uint32_t flags);
352
353 memcached_return memcached_cas_by_key(memcached_st *ptr,
354 char *master_key, size_t master_key_length,
355 char *key, size_t key_length,
356 char *value, size_t value_length,
357 time_t expiration,
358 uint32_t flags,
359 uint64_t cas);
360 memcached_return memcached_delete_by_key(memcached_st *ptr,
361 char *master_key, size_t master_key_length,
362 char *key, size_t key_length,
363 time_t expiration);
364
365 memcached_return memcached_mdelete(memcached_st *ptr,
366 char **key, size_t *key_length,
367 unsigned int number_of_keys,
368 time_t expiration);
369
370 memcached_return memcached_mdelete_by_key(memcached_st *ptr,
371 char *master_key, size_t master_key_length,
372 char **key, size_t *key_length,
373 unsigned int number_of_keys,
374 time_t expiration);
375
376 memcached_return memcached_fetch_execute(memcached_st *ptr,
377 unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
378 void *context,
379 unsigned int number_of_callbacks
380 );
381
382 /* Result Struct */
383 void memcached_result_free(memcached_result_st *result);
384 memcached_result_st *memcached_result_create(memcached_st *ptr,
385 memcached_result_st *result);
386 #define memcached_result_key_value(A) (A)->key
387 #define memcached_result_key_length(A) (A)->key_length
388 #ifdef FIX
389 #define memcached_result_value(A) memcached_string_value((A)->value)
390 #define memcached_result_length(A) memcached_string_length((A)->value)
391 #else
392 char *memcached_result_value(memcached_result_st *ptr);
393 size_t memcached_result_length(memcached_result_st *ptr);
394 #endif
395 #define memcached_result_flags(A) (A)->flags
396 #define memcached_result_cas(A) (A)->cas
397
398
399 #ifndef __WATCHPOINT_H__
400 #define __WATCHPOINT_H__
401 /* Some personal debugging functions */
402 #ifdef HAVE_DEBUG
403 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
404 #ifdef __MEMCACHED_H__
405 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
406 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
407 #endif
408 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
409 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
410 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
411 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
412 #define WATCHPOINT_ASSERT(A) assert((A));
413 #else
414 #define WATCHPOINT
415 #ifdef __MEMCACHED_H__
416 #define WATCHPOINT_ERROR(A)
417 #define WATCHPOINT_IFERROR(A)
418 #endif
419 #define WATCHPOINT_STRING(A)
420 #define WATCHPOINT_NUMBER(A)
421 #define WATCHPOINT_ERRNO(A)
422 #define WATCHPOINT_ASSERT(A)
423 #endif
424
425 #endif /* __WATCHPOINT_H__ */
426
427
428 #ifdef __cplusplus
429 }
430 #endif
431
432 #endif /* __MEMCACHED_H__ */
Resurrection of libmemcached