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
37 struct memcached_analysis_st
{
38 uint32_t average_item_size
;
39 uint32_t longest_uptime
;
40 uint32_t least_free_server
;
41 uint32_t most_consumed_server
;
42 uint32_t oldest_server
;
43 double pool_hit_ratio
;
44 uint64_t most_used_bytes
;
45 uint64_t least_remaining_bytes
;
48 struct memcached_stat_st
{
49 uint32_t connection_structures
;
50 uint32_t curr_connections
;
53 uint32_t pointer_size
;
54 uint32_t rusage_system_microseconds
;
55 uint32_t rusage_system_seconds
;
56 uint32_t rusage_user_microseconds
;
57 uint32_t rusage_user_seconds
;
60 uint32_t total_connections
;
65 uint64_t bytes_written
;
71 uint64_t limit_maxbytes
;
72 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
78 bool is_initialized
:1;
83 uint32_t continuum_points_counter
;
84 memcached_server_st
*hosts
;
85 memcached_server_st
*last_disconnected_server
;
88 uint32_t server_failure_limit
;
89 uint32_t io_msg_watermark
;
90 uint32_t io_bytes_watermark
;
91 uint32_t io_key_prefetch
;
92 uint32_t number_of_hosts
;
93 uint32_t cursor_server
;
97 int32_t connect_timeout
;
98 int32_t retry_timeout
;
99 uint32_t continuum_count
;
103 time_t next_distribution_rebuild
;
104 size_t prefix_key_length
;
105 memcached_hash hash_continuum
;
106 memcached_result_st result
;
107 memcached_continuum_item_st
*continuum
;
108 memcached_clone_func on_clone
;
109 memcached_cleanup_func on_cleanup
;
110 memcached_free_function call_free
;
111 memcached_malloc_function call_malloc
;
112 memcached_realloc_function call_realloc
;
113 memcached_calloc_function call_calloc
;
114 memcached_trigger_key get_key_failure
;
115 memcached_trigger_delete_key delete_trigger
;
116 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
117 uint32_t number_of_replicas
;
118 memcached_callback_st
*callbacks
;
122 memcached_return
memcached_version(memcached_st
*ptr
);
127 const char * memcached_lib_version(void);
130 memcached_st
*memcached_create(memcached_st
*ptr
);
132 void memcached_free(memcached_st
*ptr
);
134 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
137 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
140 memcached_return
memcached_increment(memcached_st
*ptr
,
141 const char *key
, size_t key_length
,
145 memcached_return
memcached_decrement(memcached_st
*ptr
,
146 const char *key
, size_t key_length
,
151 memcached_return
memcached_increment_by_key(memcached_st
*ptr
,
152 const char *master_key
, size_t master_key_length
,
153 const char *key
, size_t key_length
,
158 memcached_return
memcached_decrement_by_key(memcached_st
*ptr
,
159 const char *master_key
, size_t master_key_length
,
160 const char *key
, size_t key_length
,
165 memcached_return
memcached_increment_with_initial(memcached_st
*ptr
,
173 memcached_return
memcached_decrement_with_initial(memcached_st
*ptr
,
181 memcached_return
memcached_increment_with_initial_by_key(memcached_st
*ptr
,
182 const char *master_key
,
183 size_t master_key_length
,
191 memcached_return
memcached_decrement_with_initial_by_key(memcached_st
*ptr
,
192 const char *master_key
,
193 size_t master_key_length
,
201 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
203 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
205 memcached_return
memcached_stat_servername(memcached_stat_st
*memc_stat
, char *args
,
206 char *hostname
, unsigned int port
);
208 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
210 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
212 void memcached_quit(memcached_st
*ptr
);
214 const char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
216 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
218 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
220 /* The two public hash bits */
222 uint32_t memcached_generate_hash_value(const char *key
, size_t key_length
, memcached_hash hash_algorithm
);
224 uint32_t memcached_generate_hash(memcached_st
*ptr
, const char *key
, size_t key_length
);
227 memcached_return
memcached_flush_buffers(memcached_st
*mem
);
229 /* Server Public functions */
232 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
233 const char *hostname
,
236 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
237 const char *filename
);
239 memcached_return
memcached_server_add(memcached_st
*ptr
, const char *hostname
,
243 memcached_return
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
244 const char *hostname
,
248 memcached_return
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
249 const char *filename
,
252 memcached_return
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
256 void memcached_server_list_free(memcached_server_st
*ptr
);
258 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
261 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
262 const char *hostname
,
264 memcached_return
*error
);
266 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
267 const char *hostname
,
270 memcached_return
*error
);
272 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
274 memcached_server_st
*memcached_servers_parse(const char *server_strings
);
277 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*memc_stat
,
278 const char *key
, memcached_return
*error
);
280 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*memc_stat
,
281 memcached_return
*error
);
284 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
285 const char *master_key
, size_t master_key_length
,
286 const char *key
, size_t key_length
,
290 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
291 memcached_execute_function
*callback
,
293 unsigned int number_of_callbacks
);
296 memcached_return
memcached_callback_set(memcached_st
*ptr
,
297 memcached_callback flag
,
300 void *memcached_callback_get(memcached_st
*ptr
,
301 memcached_callback flag
,
302 memcached_return
*error
);
305 memcached_return
memcached_dump(memcached_st
*ptr
, memcached_dump_func
*function
, void *context
, uint32_t number_of_callbacks
);
309 memcached_return
memcached_set_memory_allocators(memcached_st
*ptr
,
310 memcached_malloc_function mem_malloc
,
311 memcached_free_function mem_free
,
312 memcached_realloc_function mem_realloc
,
313 memcached_calloc_function mem_calloc
);
316 void memcached_get_memory_allocators(memcached_st
*ptr
,
317 memcached_malloc_function
*mem_malloc
,
318 memcached_free_function
*mem_free
,
319 memcached_realloc_function
*mem_realloc
,
320 memcached_calloc_function
*mem_calloc
);
323 void *memcached_get_user_data(memcached_st
*ptr
);
325 void *memcached_set_user_data(memcached_st
*ptr
, void *data
);
328 memcached_return
run_distribution(memcached_st
*ptr
);
330 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
331 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
338 #endif /* __MEMCACHED_H__ */