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_LOCKUP_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
,
79 MEMCACHED_HASH_DEFAULT
= 0,
82 MEMCACHED_HASH_FNV1_64
,
83 MEMCACHED_HASH_FNV1A_64
,
84 MEMCACHED_HASH_FNV1_32
,
85 MEMCACHED_HASH_FNV1A_32
,
86 MEMCACHED_HASH_KETAMA
,
90 MEMCACHED_CONNECTION_UNKNOWN
,
91 MEMCACHED_CONNECTION_TCP
,
92 MEMCACHED_CONNECTION_UDP
,
93 MEMCACHED_CONNECTION_UNIX_SOCKET
,
94 } memcached_connection
;
97 MEMCACHED_NOT_ALLOCATED
,
99 } memcached_allocated
;
101 struct memcached_server_st
{
105 unsigned int stack_responses
;
106 unsigned int cursor_active
;
107 char write_buffer
[MEMCACHED_MAX_BUFFER
];
108 size_t write_buffer_offset
;
110 char read_buffer
[MEMCACHED_MAX_BUFFER
];
111 size_t read_buffer_length
;
113 memcached_allocated sockaddr_inited
;
114 struct sockaddr_in servAddr
;
115 memcached_connection type
;
116 uint8_t major_version
;
117 uint8_t minor_version
;
118 uint8_t micro_version
;
121 struct memcached_stat_st
{
124 unsigned int threads
;
126 char version
[MEMCACHED_VERSION_STRING
];
127 unsigned int pointer_size
;
128 unsigned int rusage_user
;
129 unsigned int rusage_system
;
130 unsigned int rusage_user_seconds
;
131 unsigned int rusage_user_microseconds
;
132 unsigned int rusage_system_seconds
;
133 unsigned int rusage_system_microseconds
;
134 unsigned int curr_items
;
135 unsigned int total_items
;
136 unsigned long long bytes
;
137 unsigned int curr_connections
;
138 unsigned int total_connections
;
139 unsigned int connection_structures
;
140 unsigned long long cmd_get
;
141 unsigned long long cmd_set
;
142 unsigned long long get_hits
;
143 unsigned long long get_misses
;
144 unsigned long long evictions
;
145 unsigned long long bytes_read
;
146 unsigned long long bytes_written
;
147 unsigned int limit_maxbytes
;
150 struct memcached_string_st
{
152 memcached_allocated is_allocated
;
159 struct memcached_result_st
{
160 memcached_allocated is_allocated
;
162 char key
[MEMCACHED_MAX_KEY
];
164 memcached_string_st value
;
169 struct memcached_st
{
170 memcached_allocated is_allocated
;
171 memcached_server_st
*hosts
;
172 unsigned int number_of_hosts
;
173 unsigned int cursor_server
;
176 unsigned long long flags
;
179 memcached_string_st result_buffer
;
181 memcached_return warning
; /* Future Use */
185 memcached_st
*memcached_create(memcached_st
*ptr
);
186 void memcached_free(memcached_st
*ptr
);
187 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
189 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
191 memcached_return
memcached_increment(memcached_st
*ptr
,
192 char *key
, size_t key_length
,
195 memcached_return
memcached_decrement(memcached_st
*ptr
,
196 char *key
, size_t key_length
,
199 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
200 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
201 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
202 char *hostname
, unsigned int port
);
203 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
204 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
205 void memcached_quit(memcached_st
*ptr
);
206 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
207 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
208 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
210 /* All of the functions for adding data to the server */
211 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
212 char *value
, size_t value_length
,
215 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
216 char *value
, size_t value_length
,
219 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
220 char *value
, size_t value_length
,
223 memcached_return
memcached_append(memcached_st
*ptr
,
224 char *key
, size_t key_length
,
225 char *value
, size_t value_length
,
228 memcached_return
memcached_prepend(memcached_st
*ptr
,
229 char *key
, size_t key_length
,
230 char *value
, size_t value_length
,
233 memcached_return
memcached_cas(memcached_st
*ptr
,
234 char *key
, size_t key_length
,
235 char *value
, size_t value_length
,
241 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
242 size_t *value_length
,
244 memcached_return
*error
);
245 memcached_return
memcached_mget(memcached_st
*ptr
,
246 char **keys
, size_t *key_length
,
247 unsigned int number_of_keys
);
248 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
249 size_t *value_length
, uint16_t *flags
,
250 memcached_return
*error
);
251 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
252 memcached_result_st
*result
,
253 memcached_return
*error
);
255 /* Server Public functions */
256 #define memcached_server_count(A) A->number_of_hosts
257 #define memcached_server_name(A,B) B.hostname
258 #define memcached_server_port(A,B) B.port
259 #define memcached_server_list(A) A->hosts
260 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
262 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
265 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
267 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
269 void memcached_server_list_free(memcached_server_st
*ptr
);
270 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
272 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
273 char *hostname
, unsigned int port
,
274 memcached_return
*error
);
275 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
276 memcached_server_st
*memcached_servers_parse(char *server_strings
);
278 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
279 char *key
, memcached_return
*error
);
280 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
281 memcached_return
*error
);
284 void memcached_result_free(memcached_result_st
*result
);
285 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
286 memcached_result_st
*result
);
287 #define memcached_result_key_value(A) A->key
288 #define memcached_result_key_length(A) A->key_length
290 #define memcached_result_value(A) memcached_string_value(A->value)
291 #define memcached_result_length(A) memcached_string_length(A->value)
293 char *memcached_result_value(memcached_result_st
*ptr
);
294 size_t memcached_result_length(memcached_result_st
*ptr
);
296 #define memcached_result_flags(A) A->flags
297 #define memcached_result_cas(A) A->cas
300 #ifndef __WATCHPOINT_H__
301 #define __WATCHPOINT_H__
302 /* Some personal debugging functions */
304 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
305 #ifdef __MEMCACHED_H__
306 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
308 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
309 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
310 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
311 #define WATCHPOINT_ASSERT(A) assert((A));
314 #define WATCHPOINT { 1; };
315 #define WATCHPOINT_ERROR(A) { 1; };
316 #define WATCHPOINT_STRING(A) { 1; };
317 #define WATCHPOINT_NUMBER(A) { 1; };
318 #define WATCHPOINT_ERRNO(A) { 1; };
319 #define WATCHPOINT_ASSERT(A) { 1; };
322 #ifdef __MEMCACHED_H__
323 #define WATCHPOINT_ERROR(A)
325 #define WATCHPOINT_STRING(A)
326 #define WATCHPOINT_NUMBER(A)
327 #define WATCHPOINT_ERRNO(A)
328 #define WATCHPOINT_ASSERT(A)
331 #endif /* __WATCHPOINT_H__ */
338 #endif /* __MEMCACHED_H__ */