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 #ifdef MEMCACHED_INTERNAL
22 #include <libmemcached/libmemcached_config.h>
24 #include <libmemcached/memcached_configure.h>
25 #include <libmemcached/memcached_constants.h>
26 #include <libmemcached/memcached_types.h>
27 #include <libmemcached/memcached_watchpoint.h>
28 #include <libmemcached/memcached_get.h>
29 #include <libmemcached/memcached_server.h>
30 #include <libmemcached/memcached_string.h>
31 #include <libmemcached/memcached_result.h>
37 /* These are Private and should not be used by applications */
38 #define MEMCACHED_VERSION_STRING_LENGTH 24
41 struct memcached_continuum_item_st
{
46 #define LIBMEMCACHED_VERSION_STRING "0.30"
48 struct memcached_analysis_st
{
49 uint32_t average_item_size
;
50 uint32_t longest_uptime
;
51 uint32_t least_free_server
;
52 uint32_t most_consumed_server
;
53 uint32_t oldest_server
;
54 double pool_hit_ratio
;
55 uint64_t most_used_bytes
;
56 uint64_t least_remaining_bytes
;
59 struct memcached_stat_st
{
60 uint32_t connection_structures
;
61 uint32_t curr_connections
;
64 uint32_t pointer_size
;
65 uint32_t rusage_system_microseconds
;
66 uint32_t rusage_system_seconds
;
67 uint32_t rusage_user_microseconds
;
68 uint32_t rusage_user_seconds
;
71 uint32_t total_connections
;
76 uint64_t bytes_written
;
82 uint64_t limit_maxbytes
;
83 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
91 uint32_t continuum_points_counter
;
92 memcached_server_st
*hosts
;
95 uint32_t server_failure_limit
;
96 uint32_t io_msg_watermark
;
97 uint32_t io_bytes_watermark
;
98 uint32_t io_key_prefetch
;
99 uint32_t number_of_hosts
;
100 uint32_t cursor_server
;
103 int32_t poll_timeout
;
104 int32_t connect_timeout
;
105 int32_t retry_timeout
;
106 uint32_t continuum_count
;
110 time_t next_distribution_rebuild
;
111 size_t prefix_key_length
;
112 memcached_hash hash_continuum
;
113 memcached_result_st result
;
114 memcached_continuum_item_st
*continuum
;
115 memcached_clone_func on_clone
;
116 memcached_cleanup_func on_cleanup
;
117 memcached_free_function call_free
;
118 memcached_malloc_function call_malloc
;
119 memcached_realloc_function call_realloc
;
120 memcached_trigger_key get_key_failure
;
121 memcached_trigger_delete_key delete_trigger
;
122 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
127 const char * memcached_lib_version(void);
129 memcached_st
*memcached_create(memcached_st
*ptr
);
130 void memcached_free(memcached_st
*ptr
);
131 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
133 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
135 memcached_return
memcached_increment(memcached_st
*ptr
,
136 const char *key
, size_t key_length
,
139 memcached_return
memcached_decrement(memcached_st
*ptr
,
140 const char *key
, size_t key_length
,
143 memcached_return
memcached_increment_with_initial(memcached_st
*ptr
,
150 memcached_return
memcached_decrement_with_initial(memcached_st
*ptr
,
157 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
158 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
159 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
160 char *hostname
, unsigned int port
);
161 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
162 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
163 void memcached_quit(memcached_st
*ptr
);
164 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
165 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
166 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
168 /* The two public hash bits */
169 uint32_t memcached_generate_hash_value(const char *key
, size_t key_length
, memcached_hash hash_algorithm
);
170 uint32_t memcached_generate_hash(memcached_st
*ptr
, const char *key
, size_t key_length
);
172 memcached_return
memcached_flush_buffers(memcached_st
*mem
);
174 /* Server Public functions */
176 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
177 const char *hostname
,
179 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
180 const char *filename
);
181 memcached_return
memcached_server_add(memcached_st
*ptr
, const char *hostname
,
184 memcached_return
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
185 const char *hostname
,
188 memcached_return
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
189 const char *filename
,
191 memcached_return
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
194 void memcached_server_list_free(memcached_server_st
*ptr
);
195 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
197 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
198 const char *hostname
,
200 memcached_return
*error
);
201 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
202 const char *hostname
,
205 memcached_return
*error
);
206 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
207 memcached_server_st
*memcached_servers_parse(const char *server_strings
);
209 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
210 const char *key
, memcached_return
*error
);
211 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
212 memcached_return
*error
);
214 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
215 const char *master_key
, size_t master_key_length
,
216 const char *key
, size_t key_length
,
219 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
220 memcached_execute_function
*callback
,
222 unsigned int number_of_callbacks
);
224 memcached_return
memcached_callback_set(memcached_st
*ptr
,
225 memcached_callback flag
,
227 void *memcached_callback_get(memcached_st
*ptr
,
228 memcached_callback flag
,
229 memcached_return
*error
);
231 memcached_return
memcached_dump(memcached_st
*ptr
, memcached_dump_func
*function
, void *context
, uint32_t number_of_callbacks
);
238 #include <libmemcached/memcached_storage.h>
240 #endif /* __MEMCACHED_H__ */