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_DEFAULT_PORT 11211
29 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
30 #define SMALL_STRING_LEN 1024
31 #define HUGE_STRING_LEN 8196
32 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
33 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
38 MEMCACHED_HOST_LOCKUP_FAILURE
,
39 MEMCACHED_CONNECTION_FAILURE
,
40 MEMCACHED_CONNECTION_BIND_FAILURE
,
41 MEMCACHED_WRITE_FAILURE
,
42 MEMCACHED_READ_FAILURE
,
43 MEMCACHED_UNKNOWN_READ_FAILURE
,
44 MEMCACHED_PROTOCOL_ERROR
,
45 MEMCACHED_CLIENT_ERROR
,
46 MEMCACHED_SERVER_ERROR
,
47 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
48 MEMCACHED_DATA_EXISTS
,
49 MEMCACHED_DATA_DOES_NOT_EXIST
,
53 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
54 MEMCACHED_PARTIAL_READ
,
55 MEMCACHED_SOME_ERRORS
,
62 MEMCACHED_FAIL_UNIX_SOCKET
,
63 MEMCACHED_NOT_SUPPORTED
,
64 MEMCACHED_NO_KEY_PROVIDED
,
65 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
69 MEMCACHED_BEHAVIOR_NO_BLOCK
,
70 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
71 MEMCACHED_BEHAVIOR_HASH
,
72 MEMCACHED_BEHAVIOR_KETAMA
,
73 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
74 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
78 MEMCACHED_HASH_DEFAULT
= 0,
81 MEMCACHED_HASH_FNV1_64
,
82 MEMCACHED_HASH_FNV1A_64
,
83 MEMCACHED_HASH_FNV1_32
,
84 MEMCACHED_HASH_FNV1A_32
,
85 MEMCACHED_HASH_KETAMA
,
89 MEMCACHED_CONNECTION_UNKNOWN
,
90 MEMCACHED_CONNECTION_TCP
,
91 MEMCACHED_CONNECTION_UDP
,
92 MEMCACHED_CONNECTION_UNIX_SOCKET
,
93 } memcached_connection
;
96 MEMCACHED_NOT_ALLOCATED
,
98 } memcached_allocated
;
100 struct memcached_server_st
{
104 unsigned int stack_responses
;
105 unsigned int cursor_active
;
106 char write_buffer
[MEMCACHED_MAX_BUFFER
];
107 size_t write_buffer_offset
;
108 char read_buffer
[MEMCACHED_MAX_BUFFER
];
109 size_t read_buffer_length
;
111 struct sockaddr_in servAddr
;
112 memcached_connection type
;
115 struct memcached_stat_st
{
118 unsigned int threads
;
121 unsigned int pointer_size
;
122 unsigned int rusage_user
;
123 unsigned int rusage_system
;
124 unsigned int rusage_user_seconds
;
125 unsigned int rusage_user_microseconds
;
126 unsigned int rusage_system_seconds
;
127 unsigned int rusage_system_microseconds
;
128 unsigned int curr_items
;
129 unsigned int total_items
;
130 unsigned long long bytes
;
131 unsigned int curr_connections
;
132 unsigned int total_connections
;
133 unsigned int connection_structures
;
134 unsigned long long cmd_get
;
135 unsigned long long cmd_set
;
136 unsigned long long get_hits
;
137 unsigned long long get_misses
;
138 unsigned long long evictions
;
139 unsigned long long bytes_read
;
140 unsigned long long bytes_written
;
141 unsigned int limit_maxbytes
;
144 struct memcached_string_st
{
146 memcached_allocated is_allocated
;
153 struct memcached_result_st
{
154 memcached_allocated is_allocated
;
156 char key
[MEMCACHED_MAX_KEY
];
158 memcached_string_st value
;
163 struct memcached_st
{
164 memcached_allocated is_allocated
;
165 memcached_server_st
*hosts
;
166 unsigned int number_of_hosts
;
167 unsigned int cursor_server
;
170 unsigned long long flags
;
173 memcached_string_st result_buffer
;
175 memcached_return warning
; /* Future Use */
179 memcached_st
*memcached_create(memcached_st
*ptr
);
180 void memcached_free(memcached_st
*ptr
);
181 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
183 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
185 memcached_return
memcached_increment(memcached_st
*ptr
,
186 char *key
, size_t key_length
,
189 memcached_return
memcached_decrement(memcached_st
*ptr
,
190 char *key
, size_t key_length
,
193 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
194 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
195 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
196 char *hostname
, unsigned int port
);
197 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
198 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
199 void memcached_quit(memcached_st
*ptr
);
200 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
201 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
202 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
204 /* All of the functions for adding data to the server */
205 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
206 char *value
, size_t value_length
,
209 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
210 char *value
, size_t value_length
,
213 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
214 char *value
, size_t value_length
,
219 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
220 size_t *value_length
,
222 memcached_return
*error
);
223 memcached_return
memcached_mget(memcached_st
*ptr
,
224 char **keys
, size_t *key_length
,
225 unsigned int number_of_keys
);
226 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
227 size_t *value_length
, uint16_t *flags
,
228 memcached_return
*error
);
229 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
230 memcached_result_st
*result
,
231 memcached_return
*error
);
233 /* Server Public functions */
234 #define memcached_server_count(A) A->number_of_hosts
235 #define memcached_server_name(A,B) B.hostname
236 #define memcached_server_port(A,B) B.port
237 #define memcached_server_list(A) A->hosts
238 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
240 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
243 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
245 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
247 void memcached_server_list_free(memcached_server_st
*ptr
);
248 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
250 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
251 char *hostname
, unsigned int port
,
252 memcached_return
*error
);
253 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
254 memcached_server_st
*memcached_servers_parse(char *server_strings
);
256 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
257 char *key
, memcached_return
*error
);
258 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
259 memcached_return
*error
);
262 void memcached_result_free(memcached_result_st
*result
);
263 memcached_result_st
*memcached_result_create(memcached_st
*ptr
,
264 memcached_result_st
*result
);
265 #define memcached_result_key_value(A) A->key
266 #define memcached_result_key_length(A) A->key_length
268 #define memcached_result_value(A) memcached_string_value(A->value)
269 #define memcached_result_length(A) memcached_string_length(A->value)
271 char *memcached_result_value(memcached_result_st
*ptr
);
272 size_t memcached_result_length(memcached_result_st
*ptr
);
274 #define memcached_result_flags(A) A->flags
275 #define memcached_result_cas(A) A->cas
278 #ifndef __WATCHPOINT_H__
279 #define __WATCHPOINT_H__
280 /* Some personal debugging functions */
282 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
283 #ifdef __MEMCACHED_H__
284 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
286 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
287 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
288 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
289 #define WATCHPOINT_ASSERT(A) assert((A));
292 #define WATCHPOINT { 1; };
293 #define WATCHPOINT_ERROR(A) { 1; };
294 #define WATCHPOINT_STRING(A) { 1; };
295 #define WATCHPOINT_NUMBER(A) { 1; };
296 #define WATCHPOINT_ERRNO(A) { 1; };
297 #define WATCHPOINT_ASSERT(A) { 1; };
300 #ifdef __MEMCACHED_H__
301 #define WATCHPOINT_ERROR(A)
303 #define WATCHPOINT_STRING(A)
304 #define WATCHPOINT_NUMBER(A)
305 #define WATCHPOINT_ERRNO(A)
306 #define WATCHPOINT_ASSERT(A)
309 #endif /* __WATCHPOINT_H__ */
316 #endif /* __MEMCACHED_H__ */