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/libmemcached_config.h>
19 #include <libmemcached/memcached_constants.h>
20 #include <libmemcached/memcached_types.h>
21 #include <libmemcached/memcached_watchpoint.h>
22 #include <libmemcached/memcached_server.h>
23 #include <libmemcached/memcached_string.h>
24 #include <libmemcached/memcached_result.h>
30 /* These are Private and should not be used by applications */
31 #define MEMCACHED_VERSION_STRING_LENGTH 12
34 #define MEMCACHED_DEFAULT_PORT 11211
35 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
36 #define MEMCACHED_MAX_BUFFER 8196
37 #define MEMCACHED_MAX_HOST_LENGTH 64
38 #define MEMCACHED_WHEEL_SIZE 1024
39 #define MEMCACHED_STRIDE 4
40 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
43 #define LIBMEMCACHED_VERSION_STRING "0.19"
45 struct memcached_stat_st
{
50 uint32_t pointer_size
;
51 uint32_t rusage_user_seconds
;
52 uint32_t rusage_user_microseconds
;
53 uint32_t rusage_system_seconds
;
54 uint32_t rusage_system_microseconds
;
57 uint64_t limit_maxbytes
;
58 uint32_t curr_connections
;
59 uint32_t total_connections
;
60 uint32_t connection_structures
;
68 uint64_t bytes_written
;
69 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
73 memcached_allocated is_allocated
;
74 memcached_server_st
*hosts
;
75 unsigned int number_of_hosts
;
76 unsigned int cursor_server
;
82 int32_t connect_timeout
;
83 int32_t retry_timeout
;
84 memcached_result_st result
;
86 memcached_server_distribution distribution
;
88 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
89 memcached_clone_func on_clone
;
90 memcached_cleanup_func on_cleanup
;
91 memcached_free_function call_free
;
92 memcached_malloc_function call_malloc
;
93 memcached_realloc_function call_realloc
;
94 memcached_trigger_key get_key_failure
;
95 #ifdef NOT_USED /* Future Use */
97 memcached_return warning
;
102 const char * memcached_lib_version(void);
104 memcached_st
*memcached_create(memcached_st
*ptr
);
105 void memcached_free(memcached_st
*ptr
);
106 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
108 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
110 memcached_return
memcached_increment(memcached_st
*ptr
,
111 char *key
, size_t key_length
,
114 memcached_return
memcached_decrement(memcached_st
*ptr
,
115 char *key
, size_t key_length
,
118 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
119 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
120 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
121 char *hostname
, unsigned int port
);
122 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
123 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
124 void memcached_quit(memcached_st
*ptr
);
125 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
126 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
127 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
129 /* All of the functions for adding data to the server */
130 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
131 char *value
, size_t value_length
,
134 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
135 char *value
, size_t value_length
,
138 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
139 char *value
, size_t value_length
,
142 memcached_return
memcached_append(memcached_st
*ptr
,
143 char *key
, size_t key_length
,
144 char *value
, size_t value_length
,
147 memcached_return
memcached_prepend(memcached_st
*ptr
,
148 char *key
, size_t key_length
,
149 char *value
, size_t value_length
,
152 memcached_return
memcached_cas(memcached_st
*ptr
,
153 char *key
, size_t key_length
,
154 char *value
, size_t value_length
,
160 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
161 size_t *value_length
,
163 memcached_return
*error
);
164 memcached_return
memcached_mget(memcached_st
*ptr
,
165 char **keys
, size_t *key_length
,
166 unsigned int number_of_keys
);
167 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
168 size_t *value_length
, uint32_t *flags
,
169 memcached_return
*error
);
170 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
171 memcached_result_st
*result
,
172 memcached_return
*error
);
174 /* Server Public functions */
176 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
179 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
181 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
183 void memcached_server_list_free(memcached_server_st
*ptr
);
184 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
186 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
187 char *hostname
, unsigned int port
,
188 memcached_return
*error
);
189 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
190 memcached_server_st
*memcached_servers_parse(char *server_strings
);
192 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
193 char *key
, memcached_return
*error
);
194 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
195 memcached_return
*error
);
197 char *memcached_get_by_key(memcached_st
*ptr
,
198 char *master_key
, size_t master_key_length
,
199 char *key
, size_t key_length
,
200 size_t *value_length
,
202 memcached_return
*error
);
204 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
205 char *master_key
, size_t master_key_length
,
206 char **keys
, size_t *key_length
,
207 unsigned int number_of_keys
);
209 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
210 char *master_key
, size_t master_key_length
,
211 char *key
, size_t key_length
,
212 char *value
, size_t value_length
,
216 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
217 char *master_key
, size_t master_key_length
,
218 char *key
, size_t key_length
,
219 char *value
, size_t value_length
,
223 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
224 char *master_key
, size_t master_key_length
,
225 char *key
, size_t key_length
,
226 char *value
, size_t value_length
,
230 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
231 char *master_key
, size_t master_key_length
,
232 char *key
, size_t key_length
,
233 char *value
, size_t value_length
,
237 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
238 char *master_key
, size_t master_key_length
,
239 char *key
, size_t key_length
,
240 char *value
, size_t value_length
,
244 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
245 char *master_key
, size_t master_key_length
,
246 char *key
, size_t key_length
,
247 char *value
, size_t value_length
,
251 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
252 char *master_key
, size_t master_key_length
,
253 char *key
, size_t key_length
,
256 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
257 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
259 unsigned int number_of_callbacks
262 memcached_return
memcached_callback_set(memcached_st
*ptr
,
263 memcached_callback flag
,
265 void *memcached_callback_get(memcached_st
*ptr
,
266 memcached_callback flag
,
267 memcached_return
*error
);
269 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
270 memcached_server_function
*callback
,
272 unsigned int number_of_callbacks
);
279 #endif /* __MEMCACHED_H__ */