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_constants.h>
25 #include <libmemcached/memcached_types.h>
26 #include <libmemcached/memcached_watchpoint.h>
27 #include <libmemcached/memcached_get.h>
28 #include <libmemcached/memcached_server.h>
29 #include <libmemcached/memcached_string.h>
30 #include <libmemcached/memcached_result.h>
36 /* These are Private and should not be used by applications */
37 #define MEMCACHED_VERSION_STRING_LENGTH 24
40 struct memcached_continuum_item_st
{
45 #define LIBMEMCACHED_VERSION_STRING "0.30"
47 struct memcached_analysis_st
{
48 uint32_t average_item_size
;
49 uint32_t longest_uptime
;
50 uint32_t least_free_server
;
51 uint32_t most_consumed_server
;
52 uint32_t oldest_server
;
53 double pool_hit_ratio
;
54 uint64_t most_used_bytes
;
55 uint64_t least_remaining_bytes
;
58 struct memcached_stat_st
{
59 uint32_t connection_structures
;
60 uint32_t curr_connections
;
63 uint32_t pointer_size
;
64 uint32_t rusage_system_microseconds
;
65 uint32_t rusage_system_seconds
;
66 uint32_t rusage_user_microseconds
;
67 uint32_t rusage_user_seconds
;
70 uint32_t total_connections
;
75 uint64_t bytes_written
;
81 uint64_t limit_maxbytes
;
82 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
90 uint32_t continuum_points_counter
;
91 memcached_server_st
*hosts
;
94 uint32_t server_failure_limit
;
95 uint32_t io_msg_watermark
;
96 uint32_t io_bytes_watermark
;
97 uint32_t io_key_prefetch
;
98 uint32_t number_of_hosts
;
99 uint32_t cursor_server
;
102 int32_t poll_timeout
;
103 int32_t connect_timeout
;
104 int32_t retry_timeout
;
105 uint32_t continuum_count
;
109 time_t next_distribution_rebuild
;
110 size_t prefix_key_length
;
111 memcached_hash hash_continuum
;
112 memcached_result_st result
;
113 memcached_continuum_item_st
*continuum
;
114 memcached_clone_func on_clone
;
115 memcached_cleanup_func on_cleanup
;
116 memcached_free_function call_free
;
117 memcached_malloc_function call_malloc
;
118 memcached_realloc_function call_realloc
;
119 memcached_trigger_key get_key_failure
;
120 memcached_trigger_delete_key delete_trigger
;
121 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
126 const char * memcached_lib_version(void);
128 memcached_st
*memcached_create(memcached_st
*ptr
);
129 void memcached_free(memcached_st
*ptr
);
130 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
132 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
134 memcached_return
memcached_increment(memcached_st
*ptr
,
135 const char *key
, size_t key_length
,
138 memcached_return
memcached_decrement(memcached_st
*ptr
,
139 const char *key
, size_t key_length
,
142 memcached_return
memcached_increment_with_initial(memcached_st
*ptr
,
149 memcached_return
memcached_decrement_with_initial(memcached_st
*ptr
,
156 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
157 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
158 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
159 char *hostname
, unsigned int port
);
160 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
161 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
162 void memcached_quit(memcached_st
*ptr
);
163 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
164 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
165 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
167 /* The two public hash bits */
168 uint32_t memcached_generate_hash_value(const char *key
, size_t key_length
, memcached_hash hash_algorithm
);
169 uint32_t memcached_generate_hash(memcached_st
*ptr
, const char *key
, size_t key_length
);
171 memcached_return
memcached_flush_buffers(memcached_st
*mem
);
173 /* Server Public functions */
175 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
176 const char *hostname
,
178 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
179 const char *filename
);
180 memcached_return
memcached_server_add(memcached_st
*ptr
, const char *hostname
,
183 memcached_return
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
184 const char *hostname
,
187 memcached_return
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
188 const char *filename
,
190 memcached_return
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
193 void memcached_server_list_free(memcached_server_st
*ptr
);
194 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
196 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
197 const char *hostname
,
199 memcached_return
*error
);
200 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
201 const char *hostname
,
204 memcached_return
*error
);
205 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
206 memcached_server_st
*memcached_servers_parse(const char *server_strings
);
208 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
209 const char *key
, memcached_return
*error
);
210 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
211 memcached_return
*error
);
213 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
214 const char *master_key
, size_t master_key_length
,
215 const char *key
, size_t key_length
,
218 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
219 memcached_execute_function
*callback
,
221 unsigned int number_of_callbacks
);
223 memcached_return
memcached_callback_set(memcached_st
*ptr
,
224 memcached_callback flag
,
226 void *memcached_callback_get(memcached_st
*ptr
,
227 memcached_callback flag
,
228 memcached_return
*error
);
230 memcached_return
memcached_dump(memcached_st
*ptr
, memcached_dump_func
*function
, void *context
, uint32_t number_of_callbacks
);
237 #include <libmemcached/memcached_storage.h>
239 #endif /* __MEMCACHED_H__ */