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 12
40 struct memcached_continuum_item_st
{
45 #define LIBMEMCACHED_VERSION_STRING "0.25"
47 struct memcached_stat_st
{
52 uint32_t pointer_size
;
53 uint32_t rusage_user_seconds
;
54 uint32_t rusage_user_microseconds
;
55 uint32_t rusage_system_seconds
;
56 uint32_t rusage_system_microseconds
;
59 uint64_t limit_maxbytes
;
60 uint32_t curr_connections
;
61 uint32_t total_connections
;
62 uint32_t connection_structures
;
70 uint64_t bytes_written
;
71 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
77 memcached_server_st
*hosts
;
78 uint32_t number_of_hosts
;
79 uint32_t cursor_server
;
85 int32_t connect_timeout
;
86 int32_t retry_timeout
;
87 memcached_result_st result
;
89 memcached_server_distribution distribution
;
91 uint32_t continuum_count
;
92 memcached_continuum_item_st
*continuum
;
93 memcached_clone_func on_clone
;
94 memcached_cleanup_func on_cleanup
;
95 memcached_free_function call_free
;
96 memcached_malloc_function call_malloc
;
97 memcached_realloc_function call_realloc
;
98 memcached_trigger_key get_key_failure
;
99 memcached_trigger_delete_key delete_trigger
;
100 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
101 size_t prefix_key_length
;
102 memcached_hash hash_continuum
;
103 uint32_t continuum_points_counter
;
106 uint32_t server_failure_limit
;
107 uint32_t io_msg_watermark
;
108 uint32_t io_bytes_watermark
;
113 const char * memcached_lib_version(void);
115 memcached_st
*memcached_create(memcached_st
*ptr
);
116 void memcached_free(memcached_st
*ptr
);
117 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
119 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
121 memcached_return
memcached_increment(memcached_st
*ptr
,
122 const char *key
, size_t key_length
,
125 memcached_return
memcached_decrement(memcached_st
*ptr
,
126 const char *key
, size_t key_length
,
129 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
130 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
131 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
132 char *hostname
, unsigned int port
);
133 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
134 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
135 void memcached_quit(memcached_st
*ptr
);
136 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
137 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
138 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
140 /* Server Public functions */
142 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
143 const char *hostname
,
145 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
146 const char *filename
);
147 memcached_return
memcached_server_add(memcached_st
*ptr
, const char *hostname
,
150 memcached_return
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
151 const char *hostname
,
154 memcached_return
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
155 const char *filename
,
157 memcached_return
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
160 void memcached_server_list_free(memcached_server_st
*ptr
);
161 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
163 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
164 const char *hostname
,
166 memcached_return
*error
);
167 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
168 const char *hostname
,
171 memcached_return
*error
);
172 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
173 memcached_server_st
*memcached_servers_parse(char *server_strings
);
175 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
176 char *key
, memcached_return
*error
);
177 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
178 memcached_return
*error
);
180 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
181 const char *master_key
, size_t master_key_length
,
182 const char *key
, size_t key_length
,
185 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
186 memcached_execute_function
*callback
,
188 unsigned int number_of_callbacks
);
190 memcached_return
memcached_callback_set(memcached_st
*ptr
,
191 memcached_callback flag
,
193 void *memcached_callback_get(memcached_st
*ptr
,
194 memcached_callback flag
,
195 memcached_return
*error
);
202 #include <libmemcached/memcached_storage.h>
204 #endif /* __MEMCACHED_H__ */