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 #define LIBMEMCACHED_VERSION_STRING "0.20"
36 struct memcached_stat_st
{
41 uint32_t pointer_size
;
42 uint32_t rusage_user_seconds
;
43 uint32_t rusage_user_microseconds
;
44 uint32_t rusage_system_seconds
;
45 uint32_t rusage_system_microseconds
;
48 uint64_t limit_maxbytes
;
49 uint32_t curr_connections
;
50 uint32_t total_connections
;
51 uint32_t connection_structures
;
59 uint64_t bytes_written
;
60 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
64 memcached_allocated is_allocated
;
65 memcached_server_st
*hosts
;
66 unsigned int number_of_hosts
;
67 unsigned int cursor_server
;
73 int32_t connect_timeout
;
74 int32_t retry_timeout
;
75 memcached_result_st result
;
77 memcached_server_distribution distribution
;
79 unsigned int wheel
[MEMCACHED_WHEEL_SIZE
];
80 memcached_clone_func on_clone
;
81 memcached_cleanup_func on_cleanup
;
82 memcached_free_function call_free
;
83 memcached_malloc_function call_malloc
;
84 memcached_realloc_function call_realloc
;
85 memcached_trigger_key get_key_failure
;
86 memcached_trigger_delete_key delete_trigger
;
87 #ifdef NOT_USED /* Future Use */
89 memcached_return warning
;
94 const char * memcached_lib_version(void);
96 memcached_st
*memcached_create(memcached_st
*ptr
);
97 void memcached_free(memcached_st
*ptr
);
98 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
100 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
102 memcached_return
memcached_increment(memcached_st
*ptr
,
103 char *key
, size_t key_length
,
106 memcached_return
memcached_decrement(memcached_st
*ptr
,
107 char *key
, size_t key_length
,
110 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
111 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
112 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
113 char *hostname
, unsigned int port
);
114 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
115 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
116 void memcached_quit(memcached_st
*ptr
);
117 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
118 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
119 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
122 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
123 size_t *value_length
,
125 memcached_return
*error
);
126 memcached_return
memcached_mget(memcached_st
*ptr
,
127 char **keys
, size_t *key_length
,
128 unsigned int number_of_keys
);
129 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
130 size_t *value_length
, uint32_t *flags
,
131 memcached_return
*error
);
132 memcached_result_st
*memcached_fetch_result(memcached_st
*ptr
,
133 memcached_result_st
*result
,
134 memcached_return
*error
);
136 /* Server Public functions */
138 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
141 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
143 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
145 void memcached_server_list_free(memcached_server_st
*ptr
);
146 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
148 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
149 char *hostname
, unsigned int port
,
150 memcached_return
*error
);
151 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
152 memcached_server_st
*memcached_servers_parse(char *server_strings
);
154 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
155 char *key
, memcached_return
*error
);
156 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
157 memcached_return
*error
);
159 char *memcached_get_by_key(memcached_st
*ptr
,
160 char *master_key
, size_t master_key_length
,
161 char *key
, size_t key_length
,
162 size_t *value_length
,
164 memcached_return
*error
);
166 memcached_return
memcached_mget_by_key(memcached_st
*ptr
,
167 char *master_key
, size_t master_key_length
,
168 char **keys
, size_t *key_length
,
169 unsigned int number_of_keys
);
171 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
172 char *master_key
, size_t master_key_length
,
173 char *key
, size_t key_length
,
176 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
177 unsigned int (*callback
[])(memcached_st
*ptr
, memcached_result_st
*result
, void *context
),
179 unsigned int number_of_callbacks
182 memcached_return
memcached_callback_set(memcached_st
*ptr
,
183 memcached_callback flag
,
185 void *memcached_callback_get(memcached_st
*ptr
,
186 memcached_callback flag
,
187 memcached_return
*error
);
189 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
190 memcached_server_function
*callback
,
192 unsigned int number_of_callbacks
);
199 #include <libmemcached/memcached_storage.h>
201 #endif /* __MEMCACHED_H__ */