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 #if !defined(__cplusplus)
18 #include <sys/types.h>
19 #include <netinet/in.h>
21 #include <libmemcached/visibility.h>
22 #include <libmemcached/memcached_configure.h>
23 #include <libmemcached/memcached_constants.h>
24 #include <libmemcached/memcached_types.h>
25 #include <libmemcached/memcached_get.h>
26 #include <libmemcached/memcached_server.h>
27 #include <libmemcached/memcached_string.h>
28 #include <libmemcached/memcached_result.h>
29 #include <libmemcached/memcached_storage.h>
35 #define MEMCACHED_VERSION_STRING_LENGTH 24
36 #define LIBMEMCACHED_VERSION_STRING "0.33"
38 struct memcached_analysis_st
{
39 uint32_t average_item_size
;
40 uint32_t longest_uptime
;
41 uint32_t least_free_server
;
42 uint32_t most_consumed_server
;
43 uint32_t oldest_server
;
44 double pool_hit_ratio
;
45 uint64_t most_used_bytes
;
46 uint64_t least_remaining_bytes
;
49 struct memcached_stat_st
{
50 uint32_t connection_structures
;
51 uint32_t curr_connections
;
54 uint32_t pointer_size
;
55 uint32_t rusage_system_microseconds
;
56 uint32_t rusage_system_seconds
;
57 uint32_t rusage_user_microseconds
;
58 uint32_t rusage_user_seconds
;
61 uint32_t total_connections
;
66 uint64_t bytes_written
;
72 uint64_t limit_maxbytes
;
73 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
81 uint32_t continuum_points_counter
;
82 memcached_server_st
*hosts
;
83 memcached_server_st
*last_disconnected_server
;
86 uint32_t server_failure_limit
;
87 uint32_t io_msg_watermark
;
88 uint32_t io_bytes_watermark
;
89 uint32_t io_key_prefetch
;
90 uint32_t number_of_hosts
;
91 uint32_t cursor_server
;
95 int32_t connect_timeout
;
96 int32_t retry_timeout
;
97 uint32_t continuum_count
;
101 time_t next_distribution_rebuild
;
102 size_t prefix_key_length
;
103 memcached_hash hash_continuum
;
104 memcached_result_st result
;
105 memcached_continuum_item_st
*continuum
;
106 memcached_clone_func on_clone
;
107 memcached_cleanup_func on_cleanup
;
108 memcached_free_function call_free
;
109 memcached_malloc_function call_malloc
;
110 memcached_realloc_function call_realloc
;
111 memcached_calloc_function call_calloc
;
112 memcached_trigger_key get_key_failure
;
113 memcached_trigger_delete_key delete_trigger
;
114 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
115 uint32_t number_of_replicas
;
116 memcached_callback_st
*callbacks
;
120 memcached_return
memcached_version(memcached_st
*ptr
);
125 const char * memcached_lib_version(void);
128 memcached_st
*memcached_create(memcached_st
*ptr
);
130 void memcached_free(memcached_st
*ptr
);
132 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
135 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
138 memcached_return
memcached_increment(memcached_st
*ptr
,
139 const char *key
, size_t key_length
,
143 memcached_return
memcached_decrement(memcached_st
*ptr
,
144 const char *key
, size_t key_length
,
148 memcached_return
memcached_increment_with_initial(memcached_st
*ptr
,
156 memcached_return
memcached_decrement_with_initial(memcached_st
*ptr
,
164 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
166 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
168 memcached_return
memcached_stat_servername(memcached_stat_st
*memc_stat
, char *args
,
169 char *hostname
, unsigned int port
);
171 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
173 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
175 void memcached_quit(memcached_st
*ptr
);
177 const char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
179 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
181 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
183 /* The two public hash bits */
185 uint32_t memcached_generate_hash_value(const char *key
, size_t key_length
, memcached_hash hash_algorithm
);
187 uint32_t memcached_generate_hash(memcached_st
*ptr
, const char *key
, size_t key_length
);
190 memcached_return
memcached_flush_buffers(memcached_st
*mem
);
192 /* Server Public functions */
195 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
196 const char *hostname
,
199 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
200 const char *filename
);
202 memcached_return
memcached_server_add(memcached_st
*ptr
, const char *hostname
,
206 memcached_return
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
207 const char *hostname
,
211 memcached_return
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
212 const char *filename
,
215 memcached_return
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
219 void memcached_server_list_free(memcached_server_st
*ptr
);
221 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
224 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
225 const char *hostname
,
227 memcached_return
*error
);
229 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
230 const char *hostname
,
233 memcached_return
*error
);
235 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
237 memcached_server_st
*memcached_servers_parse(const char *server_strings
);
240 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*memc_stat
,
241 const char *key
, memcached_return
*error
);
243 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*memc_stat
,
244 memcached_return
*error
);
247 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
248 const char *master_key
, size_t master_key_length
,
249 const char *key
, size_t key_length
,
253 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
254 memcached_execute_function
*callback
,
256 unsigned int number_of_callbacks
);
259 memcached_return
memcached_callback_set(memcached_st
*ptr
,
260 memcached_callback flag
,
263 void *memcached_callback_get(memcached_st
*ptr
,
264 memcached_callback flag
,
265 memcached_return
*error
);
268 memcached_return
memcached_dump(memcached_st
*ptr
, memcached_dump_func
*function
, void *context
, uint32_t number_of_callbacks
);
272 memcached_return
memcached_set_memory_allocators(memcached_st
*ptr
,
273 memcached_malloc_function mem_malloc
,
274 memcached_free_function mem_free
,
275 memcached_realloc_function mem_realloc
,
276 memcached_calloc_function mem_calloc
);
279 void memcached_get_memory_allocators(memcached_st
*ptr
,
280 memcached_malloc_function
*mem_malloc
,
281 memcached_free_function
*mem_free
,
282 memcached_realloc_function
*mem_realloc
,
283 memcached_calloc_function
*mem_calloc
);
286 void *memcached_get_user_data(memcached_st
*ptr
);
288 void *memcached_set_user_data(memcached_st
*ptr
, void *data
);
291 memcached_return
run_distribution(memcached_st
*ptr
);
297 #endif /* __MEMCACHED_H__ */