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.17"
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 #ifdef NOT_USED /* Future Use */
96 memcached_return warning
;
101 const char * memcached_lib_version(void);
103 memcached_st
*memcached_create(memcached_st
*ptr
);
104 void memcached_free(memcached_st
*ptr
);
105 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
107 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
109 memcached_return
memcached_increment(memcached_st
*ptr
,
110 char *key
, size_t key_length
,
113 memcached_return
memcached_decrement(memcached_st
*ptr
,
114 char *key
, size_t key_length
,
117 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
118 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
119 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
120 char *hostname
, unsigned int port
);
121 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
122 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
123 void memcached_quit(memcached_st
*ptr
);
124 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
125 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
126 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
128 /* All of the functions for adding data to the server */
129 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
130 char *value
, size_t value_length
,
133 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
134 char *value
, size_t value_length
,
137 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
138 char *value
, size_t value_length
,
141 memcached_return
memcached_append(memcached_st
*ptr
,
142 char *key
, size_t key_length
,
143 char *value
, size_t value_length
,
146 memcached_return
memcached_prepend(memcached_st
*ptr
,
147 char *key
, size_t key_length
,
148 char *value
, size_t value_length
,
151 memcached_return
memcached_cas(memcached_st
*ptr
,
152 char *key
, size_t key_length
,
153 char *value
, size_t value_length
,
159 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
160 size_t *value_length
,
162 memcached_return
*error
);
163 memcached_return
memcached_mget(memcached_st
*ptr
,
164 char **keys
, size_t *key_length
,
165 unsigned int number_of_keys
);
166 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
167 size_t *value_length
, uint32_t *flags
,
168 memcached_return
*error
);
169 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
170 memcached_result_st
*result
,
171 memcached_return
*error
);
173 /* Server Public functions */
175 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
178 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
180 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
182 void memcached_server_list_free(memcached_server_st
*ptr
);
183 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
185 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
186 char *hostname
, unsigned int port
,
187 memcached_return
*error
);
188 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
189 memcached_server_st
*memcached_servers_parse(char *server_strings
);
191 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
192 char *key
, memcached_return
*error
);
193 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
194 memcached_return
*error
);
196 char *memcached_get_by_key(memcached_st
*ptr
,
197 char *master_key
, size_t master_key_length
,
198 char *key
, size_t key_length
,
199 size_t *value_length
,
201 memcached_return
*error
);
203 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
204 char *master_key
, size_t master_key_length
,
205 char **keys
, size_t *key_length
,
206 unsigned int number_of_keys
);
208 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
209 char *master_key
, size_t master_key_length
,
210 char *key
, size_t key_length
,
211 char *value
, size_t value_length
,
215 memcached_return
memcached_add_by_key(memcached_st
*ptr
,
216 char *master_key
, size_t master_key_length
,
217 char *key
, size_t key_length
,
218 char *value
, size_t value_length
,
222 memcached_return
memcached_replace_by_key(memcached_st
*ptr
,
223 char *master_key
, size_t master_key_length
,
224 char *key
, size_t key_length
,
225 char *value
, size_t value_length
,
229 memcached_return
memcached_prepend_by_key(memcached_st
*ptr
,
230 char *master_key
, size_t master_key_length
,
231 char *key
, size_t key_length
,
232 char *value
, size_t value_length
,
236 memcached_return
memcached_append_by_key(memcached_st
*ptr
,
237 char *master_key
, size_t master_key_length
,
238 char *key
, size_t key_length
,
239 char *value
, size_t value_length
,
243 memcached_return
memcached_cas_by_key(memcached_st
*ptr
,
244 char *master_key
, size_t master_key_length
,
245 char *key
, size_t key_length
,
246 char *value
, size_t value_length
,
250 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
251 char *master_key
, size_t master_key_length
,
252 char *key
, size_t key_length
,
255 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
256 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
258 unsigned int number_of_callbacks
261 memcached_return
memcached_callback_set(memcached_st
*ptr
,
262 memcached_callback flag
,
264 void *memcached_callback_get(memcached_st
*ptr
,
265 memcached_callback flag
,
266 memcached_return
*error
);
268 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
269 memcached_server_function
*callback
,
271 unsigned int number_of_callbacks
);
278 #endif /* __MEMCACHED_H__ */