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>
18 #include <libmemcached/memcached_constants.h>
19 #include <libmemcached/memcached_types.h>
20 #include <libmemcached/memcached_watchpoint.h>
21 #include <libmemcached/memcached_server.h>
22 #include <libmemcached/memcached_string.h>
23 #include <libmemcached/memcached_result.h>
29 /* These are Private and should not be used by applications */
30 #define MEMCACHED_VERSION_STRING_LENGTH 12
33 #define MEMCACHED_DEFAULT_PORT 11211
34 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
35 #define MEMCACHED_MAX_BUFFER 8196
36 #define MEMCACHED_MAX_HOST_LENGTH 64
37 #define MEMCACHED_WHEEL_SIZE 1024
38 #define MEMCACHED_STRIDE 4
39 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
42 #define LIBMEMCACHED_VERSION_STRING "0.17"
44 struct memcached_stat_st
{
49 uint32_t pointer_size
;
50 uint32_t rusage_user_seconds
;
51 uint32_t rusage_user_microseconds
;
52 uint32_t rusage_system_seconds
;
53 uint32_t rusage_system_microseconds
;
56 uint64_t limit_maxbytes
;
57 uint32_t curr_connections
;
58 uint32_t total_connections
;
59 uint32_t connection_structures
;
67 uint64_t bytes_written
;
68 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
72 memcached_allocated is_allocated
;
73 memcached_server_st
*hosts
;
74 unsigned int number_of_hosts
;
75 unsigned int cursor_server
;
81 int32_t connect_timeout
;
82 int32_t retry_timeout
;
83 memcached_result_st result
;
85 memcached_server_distribution distribution
;
87 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
88 memcached_clone_func on_clone
;
89 memcached_cleanup_func on_cleanup
;
90 memcached_free_function call_free
;
91 memcached_malloc_function call_malloc
;
92 memcached_realloc_function call_realloc
;
93 #ifdef NOT_USED /* Future Use */
95 memcached_return warning
;
100 const char * memcached_lib_version(void);
102 memcached_st
*memcached_create(memcached_st
*ptr
);
103 void memcached_free(memcached_st
*ptr
);
104 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
106 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
108 memcached_return
memcached_increment(memcached_st
*ptr
,
109 char *key
, size_t key_length
,
112 memcached_return
memcached_decrement(memcached_st
*ptr
,
113 char *key
, size_t key_length
,
116 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
117 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
118 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
119 char *hostname
, unsigned int port
);
120 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
121 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
122 void memcached_quit(memcached_st
*ptr
);
123 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
124 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
125 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
127 /* All of the functions for adding data to the server */
128 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
129 char *value
, size_t value_length
,
132 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
133 char *value
, size_t value_length
,
136 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
137 char *value
, size_t value_length
,
140 memcached_return
memcached_append(memcached_st
*ptr
,
141 char *key
, size_t key_length
,
142 char *value
, size_t value_length
,
145 memcached_return
memcached_prepend(memcached_st
*ptr
,
146 char *key
, size_t key_length
,
147 char *value
, size_t value_length
,
150 memcached_return
memcached_cas(memcached_st
*ptr
,
151 char *key
, size_t key_length
,
152 char *value
, size_t value_length
,
158 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
159 size_t *value_length
,
161 memcached_return
*error
);
162 memcached_return
memcached_mget(memcached_st
*ptr
,
163 char **keys
, size_t *key_length
,
164 unsigned int number_of_keys
);
165 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
166 size_t *value_length
, uint32_t *flags
,
167 memcached_return
*error
);
168 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
169 memcached_result_st
*result
,
170 memcached_return
*error
);
172 /* Server Public functions */
174 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
177 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
179 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
181 void memcached_server_list_free(memcached_server_st
*ptr
);
182 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
184 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
185 char *hostname
, unsigned int port
,
186 memcached_return
*error
);
187 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
188 memcached_server_st
*memcached_servers_parse(char *server_strings
);
190 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
191 char *key
, memcached_return
*error
);
192 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
193 memcached_return
*error
);
195 char *memcached_get_by_key(memcached_st
*ptr
,
196 char *master_key
, size_t master_key_length
,
197 char *key
, size_t key_length
,
198 size_t *value_length
,
200 memcached_return
*error
);
202 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
203 char *master_key
, size_t master_key_length
,
204 char **keys
, size_t *key_length
,
205 unsigned int number_of_keys
);
207 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
208 char *master_key
, size_t master_key_length
,
209 char *key
, size_t key_length
,
210 char *value
, size_t value_length
,
214 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
215 char *master_key
, size_t master_key_length
,
216 char *key
, size_t key_length
,
217 char *value
, size_t value_length
,
221 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
222 char *master_key
, size_t master_key_length
,
223 char *key
, size_t key_length
,
224 char *value
, size_t value_length
,
228 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
229 char *master_key
, size_t master_key_length
,
230 char *key
, size_t key_length
,
231 char *value
, size_t value_length
,
235 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
236 char *master_key
, size_t master_key_length
,
237 char *key
, size_t key_length
,
238 char *value
, size_t value_length
,
242 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
243 char *master_key
, size_t master_key_length
,
244 char *key
, size_t key_length
,
245 char *value
, size_t value_length
,
249 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
250 char *master_key
, size_t master_key_length
,
251 char *key
, size_t key_length
,
254 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
255 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
257 unsigned int number_of_callbacks
260 memcached_return
memcached_callback_set(memcached_st
*ptr
,
261 memcached_callback flag
,
263 void *memcached_callback_get(memcached_st
*ptr
,
264 memcached_callback flag
,
265 memcached_return
*error
);
267 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
268 memcached_server_function
*callback
,
270 unsigned int number_of_callbacks
);
277 #endif /* __MEMCACHED_H__ */