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 */
41 //#define MEMCACHED_MAX_BUFFER 8196
42 #define MEMCACHED_MAX_BUFFER 8196
47 MEMCACHED_HOST_LOCKUP_FAILURE
,
48 MEMCACHED_CONNECTION_FAILURE
,
49 MEMCACHED_CONNECTION_BIND_FAILURE
,
50 MEMCACHED_WRITE_FAILURE
,
51 MEMCACHED_READ_FAILURE
,
52 MEMCACHED_UNKNOWN_READ_FAILURE
,
53 MEMCACHED_PROTOCOL_ERROR
,
54 MEMCACHED_CLIENT_ERROR
,
55 MEMCACHED_SERVER_ERROR
,
56 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
57 MEMCACHED_DATA_EXISTS
,
58 MEMCACHED_DATA_DOES_NOT_EXIST
,
62 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
63 MEMCACHED_PARTIAL_READ
,
64 MEMCACHED_SOME_ERRORS
,
69 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
73 MEMCACHED_BEHAVIOR_NO_BLOCK
,
77 MEMCACHED_NOT_ALLOCATED
= 0,
78 MEMCACHED_ALLOCATED
= 1,
79 } memcached_allocated
;
81 struct memcached_server_st
{
87 struct memcached_stat_st
{
93 unsigned int pointer_size
;
94 unsigned int rusage_user
;
95 unsigned int rusage_system
;
96 unsigned int rusage_user_seconds
;
97 unsigned int rusage_user_microseconds
;
98 unsigned int rusage_system_seconds
;
99 unsigned int rusage_system_microseconds
;
100 unsigned int curr_items
;
101 unsigned int total_items
;
102 unsigned long long bytes
;
103 unsigned int curr_connections
;
104 unsigned int total_connections
;
105 unsigned int connection_structures
;
106 unsigned long long cmd_get
;
107 unsigned long long cmd_set
;
108 unsigned long long get_hits
;
109 unsigned long long get_misses
;
110 unsigned long long evictions
;
111 unsigned long long bytes_read
;
112 unsigned long long bytes_written
;
113 unsigned int limit_maxbytes
;
116 #define MEM_NO_BLOCK (1 << 0)
118 struct memcached_string_st
{
125 struct memcached_st
{
126 memcached_allocated is_allocated
;
127 memcached_server_st
*hosts
;
128 unsigned int number_of_hosts
;
129 unsigned int cursor_server
;
130 char read_buffer
[MEMCACHED_MAX_BUFFER
];
131 size_t read_buffer_length
;
133 char write_buffer
[MEMCACHED_MAX_BUFFER
];
134 size_t write_buffer_offset
;
135 size_t write_between_flush
;
138 unsigned int stack_responses
;
139 unsigned long long flags
;
140 memcached_return warning
; /* Future Use */
144 memcached_st
*memcached_create(memcached_st
*ptr
);
145 void memcached_free(memcached_st
*ptr
);
147 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
149 memcached_return
memcached_increment(memcached_st
*ptr
,
150 char *key
, size_t key_length
,
152 unsigned int *value
);
153 memcached_return
memcached_decrement(memcached_st
*ptr
,
154 char *key
, size_t key_length
,
156 unsigned int *value
);
157 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
158 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
159 char *hostname
, unsigned int port
);
160 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
161 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
162 void memcached_quit(memcached_st
*ptr
);
163 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
164 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
);
166 /* All of the functions for adding data to the server */
167 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
168 char *value
, size_t value_length
,
171 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
172 char *value
, size_t value_length
,
175 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
176 char *value
, size_t value_length
,
181 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
182 size_t *value_length
,
184 memcached_return
*error
);
185 memcached_return
memcached_mget(memcached_st
*ptr
,
186 char **keys
, size_t *key_length
,
187 unsigned int number_of_keys
);
188 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
189 size_t *value_length
, uint16_t *flags
,
190 memcached_return
*error
);
192 /* Server Public functions */
193 #define memcached_server_count(A) A->number_of_hosts
194 #define memcached_server_name(A,B) B.hostname
195 #define memcached_server_port(A,B) B.port
196 #define memcached_server_list(A) A->hosts
198 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
201 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
202 char *hostname
, unsigned int port
,
203 memcached_return
*error
);
204 void memcached_server_list_free(memcached_server_st
*ptr
);
205 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
206 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
208 /* These are all private, do not use. */
209 memcached_return
memcached_connect(memcached_st
*ptr
);
210 memcached_return
memcached_response(memcached_st
*ptr
,
211 char *buffer
, size_t buffer_length
,
212 unsigned int server_key
);
213 unsigned int memcached_generate_hash(char *key
, size_t key_length
);
214 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
215 char *key
, memcached_return
*error
);
216 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
217 memcached_return
*error
);
221 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
222 #define memcached_string_size(A, B) B->current_size
223 #define memcached_string_value(A, B) B->string
225 memcached_string_st
*memcached_string_create(memcached_st
*ptr
, size_t initial_size
);
226 memcached_return
memcached_string_append_character(memcached_st
*ptr
,
227 memcached_string_st
*string
,
229 memcached_return
memcached_string_append(memcached_st
*ptr
, memcached_string_st
*string
,
230 char *value
, size_t length
);
231 size_t memcached_string_backspace(memcached_st
*ptr
, memcached_string_st
*string
, size_t remove
);
232 memcached_return
memcached_string_reset(memcached_st
*ptr
, memcached_string_st
*string
);
233 void memcached_string_free(memcached_st
*ptr
, memcached_string_st
*string
);
235 /* Some personal debugging functions */
236 #define WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout);
237 #define WATCHPOINT_ERROR(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
238 #define WATCHPOINT_STRING(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
239 #define WATCHPOINT_NUMBER(A) printf("WATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
240 #define WATCHPOINT_ERRNO(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, strerror(A));A= 0;fflush(stdout);
247 #endif /* __MEMCACHED_H__ */