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
,
74 MEMCACHED_BEHAVIOR_BLOCK
,
75 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
76 MEMCACHED_BEHAVIOR_TCP_DELAY
,
80 MEMCACHED_NOT_ALLOCATED
= 0,
81 MEMCACHED_ALLOCATED
= 1,
82 } memcached_allocated
;
84 struct memcached_server_st
{
90 struct memcached_stat_st
{
96 unsigned int pointer_size
;
97 unsigned int rusage_user
;
98 unsigned int rusage_system
;
99 unsigned int rusage_user_seconds
;
100 unsigned int rusage_user_microseconds
;
101 unsigned int rusage_system_seconds
;
102 unsigned int rusage_system_microseconds
;
103 unsigned int curr_items
;
104 unsigned int total_items
;
105 unsigned long long bytes
;
106 unsigned int curr_connections
;
107 unsigned int total_connections
;
108 unsigned int connection_structures
;
109 unsigned long long cmd_get
;
110 unsigned long long cmd_set
;
111 unsigned long long get_hits
;
112 unsigned long long get_misses
;
113 unsigned long long evictions
;
114 unsigned long long bytes_read
;
115 unsigned long long bytes_written
;
116 unsigned int limit_maxbytes
;
119 #define MEM_NO_BLOCK (1 << 0)
120 #define MEM_TCP_NODELAY (1 << 1)
121 #define MEM_REUSE_MEMORY (1 << 2)
123 struct memcached_string_st
{
130 struct memcached_st
{
131 memcached_allocated is_allocated
;
132 memcached_server_st
*hosts
;
133 unsigned int number_of_hosts
;
134 unsigned int cursor_server
;
135 char read_buffer
[MEMCACHED_MAX_BUFFER
];
136 size_t read_buffer_length
;
138 char write_buffer
[MEMCACHED_MAX_BUFFER
];
139 size_t write_buffer_offset
;
142 unsigned int stack_responses
;
143 unsigned long long flags
;
144 memcached_return warning
; /* Future Use */
148 memcached_st
*memcached_create(memcached_st
*ptr
);
149 void memcached_free(memcached_st
*ptr
);
151 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
153 memcached_return
memcached_increment(memcached_st
*ptr
,
154 char *key
, size_t key_length
,
156 unsigned int *value
);
157 memcached_return
memcached_decrement(memcached_st
*ptr
,
158 char *key
, size_t key_length
,
160 unsigned int *value
);
161 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
162 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
163 char *hostname
, unsigned int port
);
164 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
165 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
166 void memcached_quit(memcached_st
*ptr
);
167 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
168 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
170 /* All of the functions for adding data to the server */
171 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
172 char *value
, size_t value_length
,
175 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
176 char *value
, size_t value_length
,
179 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
180 char *value
, size_t value_length
,
185 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
186 size_t *value_length
,
188 memcached_return
*error
);
189 memcached_return
memcached_mget(memcached_st
*ptr
,
190 char **keys
, size_t *key_length
,
191 unsigned int number_of_keys
);
192 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
193 size_t *value_length
, uint16_t *flags
,
194 memcached_return
*error
);
196 /* Server Public functions */
197 #define memcached_server_count(A) A->number_of_hosts
198 #define memcached_server_name(A,B) B.hostname
199 #define memcached_server_port(A,B) B.port
200 #define memcached_server_list(A) A->hosts
202 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
205 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
206 char *hostname
, unsigned int port
,
207 memcached_return
*error
);
208 void memcached_server_list_free(memcached_server_st
*ptr
);
209 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
210 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
212 /* These are all private, do not use. */
213 memcached_return
memcached_connect(memcached_st
*ptr
);
214 memcached_return
memcached_response(memcached_st
*ptr
,
215 char *buffer
, size_t buffer_length
,
216 unsigned int server_key
);
217 unsigned int memcached_generate_hash(char *key
, size_t key_length
);
218 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
219 char *key
, memcached_return
*error
);
220 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
221 memcached_return
*error
);
225 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
226 #define memcached_string_size(A, B) B->current_size
227 #define memcached_string_value(A, B) B->string
229 memcached_string_st
*memcached_string_create(memcached_st
*ptr
, size_t initial_size
);
230 memcached_return
memcached_string_append_character(memcached_st
*ptr
,
231 memcached_string_st
*string
,
233 memcached_return
memcached_string_append(memcached_st
*ptr
, memcached_string_st
*string
,
234 char *value
, size_t length
);
235 size_t memcached_string_backspace(memcached_st
*ptr
, memcached_string_st
*string
, size_t remove
);
236 memcached_return
memcached_string_reset(memcached_st
*ptr
, memcached_string_st
*string
);
237 void memcached_string_free(memcached_st
*ptr
, memcached_string_st
*string
);
239 /* Some personal debugging functions */
240 #define WATCHPOINT printf("\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
241 #define WATCHPOINT_ERROR(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
242 #define WATCHPOINT_STRING(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
243 #define WATCHPOINT_NUMBER(A) printf("\nWATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
244 #define WATCHPOINT_ERRNO(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, strerror(A));A= 0;fflush(stdout);
251 #endif /* __MEMCACHED_H__ */