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
35 #define LIBMEMCACHED_VERSION_STRING "0.19"
37 struct continuum_item
{
42 #define LIBMEMCACHED_VERSION_STRING "0.20"
45 struct memcached_stat_st
{
50 uint32_t pointer_size
;
51 uint32_t rusage_user_seconds
;
52 uint32_t rusage_user_microseconds
;
53 uint32_t rusage_system_seconds
;
54 uint32_t rusage_system_microseconds
;
57 uint64_t limit_maxbytes
;
58 uint32_t curr_connections
;
59 uint32_t total_connections
;
60 uint32_t connection_structures
;
68 uint64_t bytes_written
;
69 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
73 memcached_allocated is_allocated
;
74 memcached_server_st
*hosts
;
75 unsigned int number_of_hosts
;
76 unsigned int cursor_server
;
82 int32_t connect_timeout
;
83 int32_t retry_timeout
;
84 memcached_result_st result
;
86 memcached_server_distribution distribution
;
88 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
89 struct continuum_item continuum
[MEMCACHED_CONTINUUM_SIZE
];
90 memcached_clone_func on_clone
;
91 memcached_cleanup_func on_cleanup
;
92 memcached_free_function call_free
;
93 memcached_malloc_function call_malloc
;
94 memcached_realloc_function call_realloc
;
95 memcached_trigger_key get_key_failure
;
96 memcached_trigger_delete_key delete_trigger
;
97 #ifdef NOT_USED /* Future Use */
99 memcached_return warning
;
105 const char * memcached_lib_version(void);
107 memcached_st
*memcached_create(memcached_st
*ptr
);
108 void memcached_free(memcached_st
*ptr
);
109 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
111 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
113 memcached_return
memcached_increment(memcached_st
*ptr
,
114 char *key
, size_t key_length
,
117 memcached_return
memcached_decrement(memcached_st
*ptr
,
118 char *key
, size_t key_length
,
121 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
122 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
123 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
124 char *hostname
, unsigned int port
);
125 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
126 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
127 void memcached_quit(memcached_st
*ptr
);
128 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
129 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
130 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
133 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
134 size_t *value_length
,
136 memcached_return
*error
);
137 memcached_return
memcached_mget(memcached_st
*ptr
,
138 char **keys
, size_t *key_length
,
139 unsigned int number_of_keys
);
140 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
141 size_t *value_length
, uint32_t *flags
,
142 memcached_return
*error
);
143 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
144 memcached_result_st
*result
,
145 memcached_return
*error
);
147 /* Server Public functions */
149 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
152 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
154 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
156 void memcached_server_list_free(memcached_server_st
*ptr
);
157 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
159 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
160 char *hostname
, unsigned int port
,
161 memcached_return
*error
);
162 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
163 memcached_server_st
*memcached_servers_parse(char *server_strings
);
165 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
166 char *key
, memcached_return
*error
);
167 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
168 memcached_return
*error
);
170 char *memcached_get_by_key(memcached_st
*ptr
,
171 char *master_key
, size_t master_key_length
,
172 char *key
, size_t key_length
,
173 size_t *value_length
,
175 memcached_return
*error
);
177 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
178 char *master_key
, size_t master_key_length
,
179 char **keys
, size_t *key_length
,
180 unsigned int number_of_keys
);
182 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
183 char *master_key
, size_t master_key_length
,
184 char *key
, size_t key_length
,
187 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
188 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
190 unsigned int number_of_callbacks
193 memcached_return
memcached_callback_set(memcached_st
*ptr
,
194 memcached_callback flag
,
196 void *memcached_callback_get(memcached_st
*ptr
,
197 memcached_callback flag
,
198 memcached_return
*error
);
200 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
201 memcached_server_function
*callback
,
203 unsigned int number_of_callbacks
);
210 #include <libmemcached/memcached_storage.h>
212 #endif /* __MEMCACHED_H__ */