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
,
71 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
75 MEMCACHED_BEHAVIOR_NO_BLOCK
,
76 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
77 MEMCACHED_BEHAVIOR_MD5_HASHING
,
78 MEMCACHED_BEHAVIOR_KETAMA
,
82 MEMCACHED_NOT_ALLOCATED
= 0,
83 MEMCACHED_ALLOCATED
= 1,
84 } memcached_allocated
;
86 struct memcached_server_st
{
90 unsigned int stack_responses
;
93 struct memcached_stat_st
{
99 unsigned int pointer_size
;
100 unsigned int rusage_user
;
101 unsigned int rusage_system
;
102 unsigned int rusage_user_seconds
;
103 unsigned int rusage_user_microseconds
;
104 unsigned int rusage_system_seconds
;
105 unsigned int rusage_system_microseconds
;
106 unsigned int curr_items
;
107 unsigned int total_items
;
108 unsigned long long bytes
;
109 unsigned int curr_connections
;
110 unsigned int total_connections
;
111 unsigned int connection_structures
;
112 unsigned long long cmd_get
;
113 unsigned long long cmd_set
;
114 unsigned long long get_hits
;
115 unsigned long long get_misses
;
116 unsigned long long evictions
;
117 unsigned long long bytes_read
;
118 unsigned long long bytes_written
;
119 unsigned int limit_maxbytes
;
122 struct memcached_string_st
{
129 struct memcached_st
{
130 memcached_allocated is_allocated
;
131 memcached_server_st
*hosts
;
132 unsigned int number_of_hosts
;
133 unsigned int cursor_server
;
134 char read_buffer
[MEMCACHED_MAX_BUFFER
];
135 size_t read_buffer_length
;
137 char write_buffer
[MEMCACHED_MAX_BUFFER
];
138 size_t write_buffer_offset
;
141 unsigned long long flags
;
142 memcached_return warning
; /* Future Use */
146 memcached_st
*memcached_create(memcached_st
*ptr
);
147 void memcached_free(memcached_st
*ptr
);
149 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
151 memcached_return
memcached_increment(memcached_st
*ptr
,
152 char *key
, size_t key_length
,
154 unsigned int *value
);
155 memcached_return
memcached_decrement(memcached_st
*ptr
,
156 char *key
, size_t key_length
,
158 unsigned int *value
);
159 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
160 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
161 char *hostname
, unsigned int port
);
162 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
163 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
164 void memcached_quit(memcached_st
*ptr
);
165 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
166 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
167 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
169 /* All of the functions for adding data to the server */
170 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
171 char *value
, size_t value_length
,
174 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
175 char *value
, size_t value_length
,
178 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
179 char *value
, size_t value_length
,
184 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
185 size_t *value_length
,
187 memcached_return
*error
);
188 memcached_return
memcached_mget(memcached_st
*ptr
,
189 char **keys
, size_t *key_length
,
190 unsigned int number_of_keys
);
191 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
192 size_t *value_length
, uint16_t *flags
,
193 memcached_return
*error
);
195 /* Server Public functions */
196 #define memcached_server_count(A) A->number_of_hosts
197 #define memcached_server_name(A,B) B.hostname
198 #define memcached_server_port(A,B) B.port
199 #define memcached_server_list(A) A->hosts
200 #define memcached_server_response_increment(A,B) A->hosts[B].stack_responses++
201 #define memcached_server_response_decrement(A,B) A->hosts[B].stack_responses--
202 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
204 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
207 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
208 char *hostname
, unsigned int port
,
209 memcached_return
*error
);
210 void memcached_server_list_free(memcached_server_st
*ptr
);
211 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
212 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
213 memcached_server_st
*memcached_servers_parse(char *server_strings
);
216 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
217 #define memcached_string_size(A, B) B->current_size
218 #define memcached_string_value(A, B) B->string
220 memcached_string_st
*memcached_string_create(memcached_st
*ptr
, size_t initial_size
);
221 memcached_return
memcached_string_append_character(memcached_st
*ptr
,
222 memcached_string_st
*string
,
224 memcached_return
memcached_string_append(memcached_st
*ptr
, memcached_string_st
*string
,
225 char *value
, size_t length
);
226 size_t memcached_string_backspace(memcached_st
*ptr
, memcached_string_st
*string
, size_t remove
);
227 memcached_return
memcached_string_reset(memcached_st
*ptr
, memcached_string_st
*string
);
228 void memcached_string_free(memcached_st
*ptr
, memcached_string_st
*string
);
230 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
231 char *key
, memcached_return
*error
);
232 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
233 memcached_return
*error
);
235 /* Some personal debugging functions */
236 #define WATCHPOINT printf("\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
237 #define WATCHPOINT_ERROR(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
238 #define WATCHPOINT_STRING(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
239 #define WATCHPOINT_NUMBER(A) printf("\nWATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
240 #define WATCHPOINT_ERRNO(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, strerror(A));A= 0;fflush(stdout);
247 #endif /* __MEMCACHED_H__ */