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>
21 typedef struct memcached_st memcached_st
;
22 typedef struct memcached_stat_st memcached_stat_st
;
23 typedef struct memcached_string_st memcached_string_st
;
24 typedef struct memcached_server_st memcached_server_st
;
26 #define MEMCACHED_DEFAULT_PORT 11211
27 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
28 #define SMALL_STRING_LEN 1024
29 #define HUGE_STRING_LEN 8196
30 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
31 //#define MEMCACHED_MAX_BUFFER 8196
32 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
37 MEMCACHED_HOST_LOCKUP_FAILURE
,
38 MEMCACHED_CONNECTION_FAILURE
,
39 MEMCACHED_CONNECTION_BIND_FAILURE
,
40 MEMCACHED_WRITE_FAILURE
,
41 MEMCACHED_READ_FAILURE
,
42 MEMCACHED_UNKNOWN_READ_FAILURE
,
43 MEMCACHED_PROTOCOL_ERROR
,
44 MEMCACHED_CLIENT_ERROR
,
45 MEMCACHED_SERVER_ERROR
,
46 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
47 MEMCACHED_DATA_EXISTS
,
48 MEMCACHED_DATA_DOES_NOT_EXIST
,
52 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
53 MEMCACHED_PARTIAL_READ
,
54 MEMCACHED_SOME_ERRORS
,
61 MEMCACHED_FAIL_UNIX_SOCKET
,
62 MEMCACHED_NOT_SUPPORTED
,
63 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
67 MEMCACHED_BEHAVIOR_NO_BLOCK
,
68 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
69 MEMCACHED_BEHAVIOR_MD5_HASHING
,
70 MEMCACHED_BEHAVIOR_CRC_HASHING
,
71 MEMCACHED_BEHAVIOR_KETAMA
,
72 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
73 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
77 MEMCACHED_CONNECTION_UNKNOWN
,
78 MEMCACHED_CONNECTION_TCP
,
79 MEMCACHED_CONNECTION_UDP
,
80 MEMCACHED_CONNECTION_UNIX_SOCKET
,
81 } memcached_connection
;
84 MEMCACHED_NOT_ALLOCATED
= 0,
85 MEMCACHED_ALLOCATED
= 1,
86 } memcached_allocated
;
88 struct memcached_server_st
{
92 unsigned int stack_responses
;
93 unsigned int cursor_active
;
94 memcached_connection type
;
97 struct memcached_stat_st
{
100 unsigned int threads
;
103 unsigned int pointer_size
;
104 unsigned int rusage_user
;
105 unsigned int rusage_system
;
106 unsigned int rusage_user_seconds
;
107 unsigned int rusage_user_microseconds
;
108 unsigned int rusage_system_seconds
;
109 unsigned int rusage_system_microseconds
;
110 unsigned int curr_items
;
111 unsigned int total_items
;
112 unsigned long long bytes
;
113 unsigned int curr_connections
;
114 unsigned int total_connections
;
115 unsigned int connection_structures
;
116 unsigned long long cmd_get
;
117 unsigned long long cmd_set
;
118 unsigned long long get_hits
;
119 unsigned long long get_misses
;
120 unsigned long long evictions
;
121 unsigned long long bytes_read
;
122 unsigned long long bytes_written
;
123 unsigned int limit_maxbytes
;
126 struct memcached_string_st
{
133 struct memcached_st
{
134 memcached_allocated is_allocated
;
135 memcached_server_st
*hosts
;
136 unsigned int number_of_hosts
;
137 unsigned int cursor_server
;
138 char read_buffer
[MEMCACHED_MAX_BUFFER
];
139 size_t read_buffer_length
;
141 char write_buffer
[MEMCACHED_MAX_BUFFER
];
142 size_t write_buffer_offset
;
145 unsigned long long flags
;
148 memcached_return warning
; /* Future Use */
152 memcached_st
*memcached_create(memcached_st
*ptr
);
153 void memcached_free(memcached_st
*ptr
);
154 memcached_st
*memcached_clone(memcached_st
*clone
, memcached_st
*ptr
);
156 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
158 memcached_return
memcached_increment(memcached_st
*ptr
,
159 char *key
, size_t key_length
,
161 unsigned int *value
);
162 memcached_return
memcached_decrement(memcached_st
*ptr
,
163 char *key
, size_t key_length
,
165 unsigned int *value
);
166 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
167 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
168 char *hostname
, unsigned int port
);
169 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
170 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
171 void memcached_quit(memcached_st
*ptr
);
172 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
173 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
174 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
176 /* All of the functions for adding data to the server */
177 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
178 char *value
, size_t value_length
,
181 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
182 char *value
, size_t value_length
,
185 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
186 char *value
, size_t value_length
,
191 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
192 size_t *value_length
,
194 memcached_return
*error
);
195 memcached_return
memcached_mget(memcached_st
*ptr
,
196 char **keys
, size_t *key_length
,
197 unsigned int number_of_keys
);
198 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
199 size_t *value_length
, uint16_t *flags
,
200 memcached_return
*error
);
202 /* Server Public functions */
203 #define memcached_server_count(A) A->number_of_hosts
204 #define memcached_server_name(A,B) B.hostname
205 #define memcached_server_port(A,B) B.port
206 #define memcached_server_list(A) A->hosts
207 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
209 memcached_return
memcached_server_add_unix_socket(memcached_st
*ptr
,
211 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
213 void memcached_server_list_free(memcached_server_st
*ptr
);
214 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
216 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
217 char *hostname
, unsigned int port
,
218 memcached_return
*error
);
219 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
220 memcached_server_st
*memcached_servers_parse(char *server_strings
);
222 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
223 char *key
, memcached_return
*error
);
224 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
225 memcached_return
*error
);
227 /* Some personal debugging functions */
229 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
230 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
231 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
232 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
233 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
234 #define WATCHPOINT_ASSERT(A) assert((A));
237 #define WATCHPOINT { 1; };
238 #define WATCHPOINT_ERROR(A) { 1; };
239 #define WATCHPOINT_STRING(A) { 1; };
240 #define WATCHPOINT_NUMBER(A) { 1; };
241 #define WATCHPOINT_ERRNO(A) { 1; };
242 #define WATCHPOINT_ASSERT(A) { 1; };
245 #define WATCHPOINT_ERROR(A)
246 #define WATCHPOINT_STRING(A)
247 #define WATCHPOINT_NUMBER(A)
248 #define WATCHPOINT_ERRNO(A)
249 #define WATCHPOINT_ASSERT(A)
257 #endif /* __MEMCACHED_H__ */