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 LIBMEMCACHED_VERSION_STRING "0.19"
36 struct memcached_stat_st
{
41 uint32_t pointer_size
;
42 uint32_t rusage_user_seconds
;
43 uint32_t rusage_user_microseconds
;
44 uint32_t rusage_system_seconds
;
45 uint32_t rusage_system_microseconds
;
48 uint64_t limit_maxbytes
;
49 uint32_t curr_connections
;
50 uint32_t total_connections
;
51 uint32_t connection_structures
;
59 uint64_t bytes_written
;
60 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
64 memcached_allocated is_allocated
;
65 memcached_server_st
*hosts
;
66 unsigned int number_of_hosts
;
67 unsigned int cursor_server
;
73 int32_t connect_timeout
;
74 int32_t retry_timeout
;
75 memcached_result_st result
;
77 memcached_server_distribution distribution
;
79 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
80 memcached_clone_func on_clone
;
81 memcached_cleanup_func on_cleanup
;
82 memcached_free_function call_free
;
83 memcached_malloc_function call_malloc
;
84 memcached_realloc_function call_realloc
;
85 memcached_trigger_key get_key_failure
;
86 #ifdef NOT_USED /* Future Use */
88 memcached_return warning
;
93 const char * memcached_lib_version(void);
95 memcached_st
*memcached_create(memcached_st
*ptr
);
96 void memcached_free(memcached_st
*ptr
);
97 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
99 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
101 memcached_return
memcached_increment(memcached_st
*ptr
,
102 char *key
, size_t key_length
,
105 memcached_return
memcached_decrement(memcached_st
*ptr
,
106 char *key
, size_t key_length
,
109 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
110 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
111 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
112 char *hostname
, unsigned int port
);
113 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
114 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
115 void memcached_quit(memcached_st
*ptr
);
116 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
117 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
118 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
120 /* All of the functions for adding data to the server */
121 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
122 char *value
, size_t value_length
,
125 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
126 char *value
, size_t value_length
,
129 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
130 char *value
, size_t value_length
,
133 memcached_return
memcached_append(memcached_st
*ptr
,
134 char *key
, size_t key_length
,
135 char *value
, size_t value_length
,
138 memcached_return
memcached_prepend(memcached_st
*ptr
,
139 char *key
, size_t key_length
,
140 char *value
, size_t value_length
,
143 memcached_return
memcached_cas(memcached_st
*ptr
,
144 char *key
, size_t key_length
,
145 char *value
, size_t value_length
,
151 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
152 size_t *value_length
,
154 memcached_return
*error
);
155 memcached_return
memcached_mget(memcached_st
*ptr
,
156 char **keys
, size_t *key_length
,
157 unsigned int number_of_keys
);
158 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
159 size_t *value_length
, uint32_t *flags
,
160 memcached_return
*error
);
161 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
162 memcached_result_st
*result
,
163 memcached_return
*error
);
165 /* Server Public functions */
167 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
170 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
172 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
174 void memcached_server_list_free(memcached_server_st
*ptr
);
175 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
177 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
178 char *hostname
, unsigned int port
,
179 memcached_return
*error
);
180 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
181 memcached_server_st
*memcached_servers_parse(char *server_strings
);
183 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
184 char *key
, memcached_return
*error
);
185 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
186 memcached_return
*error
);
188 char *memcached_get_by_key(memcached_st
*ptr
,
189 char *master_key
, size_t master_key_length
,
190 char *key
, size_t key_length
,
191 size_t *value_length
,
193 memcached_return
*error
);
195 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
196 char *master_key
, size_t master_key_length
,
197 char **keys
, size_t *key_length
,
198 unsigned int number_of_keys
);
200 memcached_return
memcached_set_by_key(memcached_st
*ptr
,
201 char *master_key
, size_t master_key_length
,
202 char *key
, size_t key_length
,
203 char *value
, size_t value_length
,
207 memcached_return
memcached_add_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_replace_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_prepend_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_append_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_cas_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_delete_by_key(memcached_st
*ptr
,
243 char *master_key
, size_t master_key_length
,
244 char *key
, size_t key_length
,
247 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
248 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
250 unsigned int number_of_callbacks
253 memcached_return
memcached_callback_set(memcached_st
*ptr
,
254 memcached_callback flag
,
256 void *memcached_callback_get(memcached_st
*ptr
,
257 memcached_callback flag
,
258 memcached_return
*error
);
260 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
261 memcached_server_function
*callback
,
263 unsigned int number_of_callbacks
);
270 #endif /* __MEMCACHED_H__ */