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_get.h>
23 #include <libmemcached/memcached_server.h>
24 #include <libmemcached/memcached_string.h>
25 #include <libmemcached/memcached_result.h>
31 /* These are Private and should not be used by applications */
32 #define MEMCACHED_VERSION_STRING_LENGTH 12
35 struct memcached_continuum_item_st
{
40 #define LIBMEMCACHED_VERSION_STRING "0.22"
42 struct memcached_stat_st
{
47 uint32_t pointer_size
;
48 uint32_t rusage_user_seconds
;
49 uint32_t rusage_user_microseconds
;
50 uint32_t rusage_system_seconds
;
51 uint32_t rusage_system_microseconds
;
54 uint64_t limit_maxbytes
;
55 uint32_t curr_connections
;
56 uint32_t total_connections
;
57 uint32_t connection_structures
;
65 uint64_t bytes_written
;
66 char version
[MEMCACHED_VERSION_STRING_LENGTH
];
70 memcached_allocated is_allocated
;
71 memcached_server_st
*hosts
;
72 unsigned int number_of_hosts
;
73 unsigned int cursor_server
;
79 int32_t connect_timeout
;
80 int32_t retry_timeout
;
81 memcached_result_st result
;
83 memcached_server_distribution distribution
;
87 uint32_t continuum_count
;
88 memcached_continuum_item_st
*continuum
;
89 memcached_clone_func on_clone
;
90 memcached_cleanup_func on_cleanup
;
91 memcached_free_function call_free
;
92 memcached_malloc_function call_malloc
;
93 memcached_realloc_function call_realloc
;
94 memcached_trigger_key get_key_failure
;
95 memcached_trigger_delete_key delete_trigger
;
96 char prefix_key
[MEMCACHED_PREFIX_KEY_MAX_SIZE
];
97 size_t prefix_key_length
;
98 #ifdef NOT_USED /* Future Use */
100 memcached_return warning
;
106 const char * memcached_lib_version(void);
108 memcached_st
*memcached_create(memcached_st
*ptr
);
109 void memcached_free(memcached_st
*ptr
);
110 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
112 memcached_return
memcached_delete(memcached_st
*ptr
, const char *key
, size_t key_length
,
114 memcached_return
memcached_increment(memcached_st
*ptr
,
115 const char *key
, size_t key_length
,
118 memcached_return
memcached_decrement(memcached_st
*ptr
,
119 const char *key
, size_t key_length
,
122 void memcached_stat_free(memcached_st
*, memcached_stat_st
*);
123 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
124 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
125 char *hostname
, unsigned int port
);
126 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
127 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
128 void memcached_quit(memcached_st
*ptr
);
129 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
130 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, uint64_t data
);
131 uint64_t memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
133 /* Server Public functions */
135 memcached_return
memcached_server_add_udp(memcached_st
*ptr
,
138 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
140 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
142 void memcached_server_list_free(memcached_server_st
*ptr
);
143 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
145 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
146 char *hostname
, unsigned int port
,
147 memcached_return
*error
);
148 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
149 memcached_server_st
*memcached_servers_parse(char *server_strings
);
151 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
152 char *key
, memcached_return
*error
);
153 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
154 memcached_return
*error
);
156 memcached_return
memcached_delete_by_key(memcached_st
*ptr
,
157 const char *master_key
, size_t master_key_length
,
158 const char *key
, size_t key_length
,
161 memcached_return
memcached_fetch_execute(memcached_st
*ptr
,
162 memcached_execute_function
*callback
,
164 unsigned int number_of_callbacks
);
166 memcached_return
memcached_callback_set(memcached_st
*ptr
,
167 memcached_callback flag
,
169 void *memcached_callback_get(memcached_st
*ptr
,
170 memcached_callback flag
,
171 memcached_return
*error
);
173 memcached_return
memcached_server_cursor(memcached_st
*ptr
,
174 memcached_server_function
*callback
,
176 unsigned int number_of_callbacks
);
183 #include <libmemcached/memcached_storage.h>
185 #endif /* __MEMCACHED_H__ */