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__
16 #include <sys/types.h>
17 #include <sys/socket.h>
18 #include <netinet/in.h>
19 #include <arpa/inet.h>
31 typedef struct memcached_st memcached_st
;
32 typedef struct memcached_stat_st memcached_stat_st
;
33 typedef struct memcached_string_st memcached_string_st
;
34 typedef struct memcached_server_st memcached_server_st
;
36 #define MEMCACHED_DEFAULT_PORT 11211
37 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
38 #define SMALL_STRING_LEN 1024
39 #define HUGE_STRING_LEN 8196
40 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
45 MEMCACHED_HOST_LOCKUP_FAILURE
,
46 MEMCACHED_CONNECTION_FAILURE
,
47 MEMCACHED_CONNECTION_BIND_FAILURE
,
48 MEMCACHED_WRITE_FAILURE
,
49 MEMCACHED_READ_FAILURE
,
50 MEMCACHED_UNKNOWN_READ_FAILURE
,
51 MEMCACHED_PROTOCOL_ERROR
,
52 MEMCACHED_CLIENT_ERROR
,
53 MEMCACHED_SERVER_ERROR
,
54 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
55 MEMCACHED_DATA_EXISTS
,
56 MEMCACHED_DATA_DOES_NOT_EXIST
,
59 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
60 MEMCACHED_PARTIAL_READ
,
61 MEMCACHED_SOME_ERRORS
,
66 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
70 MEMCACHED_NOT_ALLOCATED
= 0,
71 MEMCACHED_ALLOCATED
= 1,
72 } memcached_allocated
;
74 struct memcached_server_st
{
80 struct memcached_stat_st
{
86 unsigned int pointer_size
;
87 unsigned int rusage_user
;
88 unsigned int rusage_system
;
89 unsigned int rusage_user_seconds
;
90 unsigned int rusage_user_microseconds
;
91 unsigned int rusage_system_seconds
;
92 unsigned int rusage_system_microseconds
;
93 unsigned int curr_items
;
94 unsigned int total_items
;
95 unsigned long long bytes
;
96 unsigned int curr_connections
;
97 unsigned int total_connections
;
98 unsigned int connection_structures
;
99 unsigned long long cmd_get
;
100 unsigned long long cmd_set
;
101 unsigned long long get_hits
;
102 unsigned long long get_misses
;
103 unsigned long long evictions
;
104 unsigned long long bytes_read
;
105 unsigned long long bytes_written
;
106 unsigned int limit_maxbytes
;
109 struct memcached_string_st
{
116 struct memcached_st
{
117 memcached_allocated is_allocated
;
118 memcached_server_st
*hosts
;
119 unsigned int number_of_hosts
;
120 unsigned int cursor_server
;
125 memcached_st
*memcached_init(memcached_st
*ptr
);
126 void memcached_deinit(memcached_st
*ptr
);
128 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
130 memcached_return
memcached_increment(memcached_st
*ptr
,
131 char *key
, size_t key_length
,
133 unsigned int *value
);
134 memcached_return
memcached_decrement(memcached_st
*ptr
,
135 char *key
, size_t key_length
,
137 unsigned int *value
);
138 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
139 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
140 char *hostname
, unsigned int port
);
141 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
142 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
143 void memcached_quit(memcached_st
*ptr
);
144 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
146 /* All of the functions for adding data to the server */
147 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
148 char *value
, size_t value_length
,
151 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
152 char *value
, size_t value_length
,
155 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
156 char *value
, size_t value_length
,
161 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
162 size_t *value_length
,
164 memcached_return
*error
);
165 memcached_return
memcached_mget(memcached_st
*ptr
,
166 char **keys
, size_t *key_length
,
167 unsigned int number_of_keys
);
168 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
169 size_t *value_length
, uint16_t *flags
,
170 memcached_return
*error
);
172 /* Server Public functions */
173 #define memcached_server_count(A) A->number_of_hosts
174 #define memcached_server_name(A,B) B.hostname
175 #define memcached_server_port(A,B) B.port
176 #define memcached_server_list(A) A->hosts
178 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
181 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
182 char *hostname
, unsigned int port
,
183 memcached_return
*error
);
184 void memcached_server_list_free(memcached_server_st
*ptr
);
185 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
186 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
188 /* These are all private, do not use. */
189 memcached_return
memcached_connect(memcached_st
*ptr
);
190 memcached_return
memcached_response(memcached_st
*ptr
,
191 char *buffer
, size_t buffer_length
,
192 unsigned int server_key
);
193 unsigned int memcached_generate_hash(char *key
, size_t key_length
);
194 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
195 char *key
, memcached_return
*error
);
196 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
197 memcached_return
*error
);
201 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
202 #define memcached_string_size(A, B) B->current_size
203 #define memcached_string_value(A, B) B->string
205 memcached_string_st
*memcached_string_init(memcached_st
*ptr
, size_t initial_size
);
206 memcached_return
memcached_string_append_character(memcached_st
*ptr
,
207 memcached_string_st
*string
,
209 memcached_return
memcached_string_append(memcached_st
*ptr
, memcached_string_st
*string
,
210 char *value
, size_t length
);
211 size_t memcached_string_backspace(memcached_st
*ptr
, memcached_string_st
*string
, size_t remove
);
212 memcached_return
memcached_string_reset(memcached_st
*ptr
, memcached_string_st
*string
);
213 void memcached_string_free(memcached_st
*ptr
, memcached_string_st
*string
);
215 /* Some personal debugging functions */
216 #define WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout);
217 #define WATCHPOINT_ERROR(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
218 #define WATCHPOINT_STRING(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
219 #define WATCHPOINT_NUMBER(A) printf("WATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
226 #endif /* __MEMCACHED_H__ */