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 #include <sys/types.h>
16 #include <netinet/in.h>
18 #include <libmemcached/libmemcached_config.h>
19 #include <libmemcached/memcached_constants.h>
20 #include <libmemcached/memcached_types.h>
21 #include <libmemcached/memcached_watchpoint.h>
22 #include <libmemcached/memcached_server.h>
23 #include <libmemcached/memcached_string.h>
24 #include <libmemcached/memcached_result.h>
30 /* These are Private and should not be used by applications */
31 #define MEMCACHED_VERSION_STRING_LENGTH 12
34 struct memcached_continuum_item_st
{
39 #define LIBMEMCACHED_VERSION_STRING "0.20"
41 struct memcached_stat_st
{
46 uint32_t pointer_size
;
47 uint32_t rusage_user_seconds
;
48 uint32_t rusage_user_microseconds
;
49 uint32_t rusage_system_seconds
;
50 uint32_t rusage_system_microseconds
;
53 uint64_t limit_maxbytes
;
54 uint32_t curr_connections
;
55 uint32_t total_connections
;
56 uint32_t connection_structures
;
64 uint64_t bytes_written
;
65 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
69 memcached_allocated is_allocated
;
70 memcached_server_st
*hosts
;
71 unsigned int number_of_hosts
;
72 unsigned int cursor_server
;
78 int32_t connect_timeout
;
79 int32_t retry_timeout
;
80 memcached_result_st result
;
82 memcached_server_distribution distribution
;
86 uint32_t continuum_count
;
87 memcached_continuum_item_st
*continuum
;
88 memcached_clone_func on_clone
;
89 memcached_cleanup_func on_cleanup
;
90 memcached_free_function call_free
;
91 memcached_malloc_function call_malloc
;
92 memcached_realloc_function call_realloc
;
93 memcached_trigger_key get_key_failure
;
94 memcached_trigger_delete_key delete_trigger
;
95 #ifdef NOT_USED /* Future Use */
97 memcached_return warning
;
103 const char * memcached_lib_version(void);
105 memcached_st
*memcached_create(memcached_st
*ptr
);
106 void memcached_free(memcached_st
*ptr
);
107 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
109 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
111 memcached_return
memcached_increment(memcached_st
*ptr
,
112 char *key
, size_t key_length
,
115 memcached_return
memcached_decrement(memcached_st
*ptr
,
116 char *key
, size_t key_length
,
119 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
120 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
121 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
122 char *hostname
, unsigned int port
);
123 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
124 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
125 void memcached_quit(memcached_st
*ptr
);
126 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
127 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
128 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
131 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
132 size_t *value_length
,
134 memcached_return
*error
);
135 memcached_return
memcached_mget(memcached_st
*ptr
,
136 char **keys
, size_t *key_length
,
137 unsigned int number_of_keys
);
138 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
139 size_t *value_length
, uint32_t *flags
,
140 memcached_return
*error
);
141 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
142 memcached_result_st
*result
,
143 memcached_return
*error
);
145 /* Server Public functions */
147 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
150 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
152 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
154 void memcached_server_list_free(memcached_server_st
*ptr
);
155 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
157 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
158 char *hostname
, unsigned int port
,
159 memcached_return
*error
);
160 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
161 memcached_server_st
*memcached_servers_parse(char *server_strings
);
163 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
164 char *key
, memcached_return
*error
);
165 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
166 memcached_return
*error
);
168 char *memcached_get_by_key(memcached_st
*ptr
,
169 char *master_key
, size_t master_key_length
,
170 char *key
, size_t key_length
,
171 size_t *value_length
,
173 memcached_return
*error
);
175 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
176 char *master_key
, size_t master_key_length
,
177 char **keys
, size_t *key_length
,
178 unsigned int number_of_keys
);
180 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
181 char *master_key
, size_t master_key_length
,
182 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
);
197 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
198 memcached_server_function
*callback
,
200 unsigned int number_of_callbacks
);
207 #include <libmemcached/memcached_storage.h>
209 #endif /* __MEMCACHED_H__ */