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__
20 typedef struct memcached_st memcached_st
;
21 typedef struct memcached_stat_st memcached_stat_st
;
22 typedef struct memcached_string_st memcached_string_st
;
23 typedef struct memcached_server_st memcached_server_st
;
25 #define MEMCACHED_DEFAULT_PORT 11211
26 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
27 #define SMALL_STRING_LEN 1024
28 #define HUGE_STRING_LEN 8196
29 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
30 //#define MEMCACHED_MAX_BUFFER 8196
31 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN*2
36 MEMCACHED_HOST_LOCKUP_FAILURE
,
37 MEMCACHED_CONNECTION_FAILURE
,
38 MEMCACHED_CONNECTION_BIND_FAILURE
,
39 MEMCACHED_WRITE_FAILURE
,
40 MEMCACHED_READ_FAILURE
,
41 MEMCACHED_UNKNOWN_READ_FAILURE
,
42 MEMCACHED_PROTOCOL_ERROR
,
43 MEMCACHED_CLIENT_ERROR
,
44 MEMCACHED_SERVER_ERROR
,
45 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
46 MEMCACHED_DATA_EXISTS
,
47 MEMCACHED_DATA_DOES_NOT_EXIST
,
51 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
52 MEMCACHED_PARTIAL_READ
,
53 MEMCACHED_SOME_ERRORS
,
60 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
64 MEMCACHED_BEHAVIOR_NO_BLOCK
,
65 MEMCACHED_BEHAVIOR_TCP_NODELAY
,
66 MEMCACHED_BEHAVIOR_MD5_HASHING
,
67 MEMCACHED_BEHAVIOR_KETAMA
,
68 MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
,
69 MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
,
73 MEMCACHED_NOT_ALLOCATED
= 0,
74 MEMCACHED_ALLOCATED
= 1,
75 } memcached_allocated
;
77 struct memcached_server_st
{
81 unsigned int stack_responses
;
82 unsigned int cursor_active
;
85 struct memcached_stat_st
{
91 unsigned int pointer_size
;
92 unsigned int rusage_user
;
93 unsigned int rusage_system
;
94 unsigned int rusage_user_seconds
;
95 unsigned int rusage_user_microseconds
;
96 unsigned int rusage_system_seconds
;
97 unsigned int rusage_system_microseconds
;
98 unsigned int curr_items
;
99 unsigned int total_items
;
100 unsigned long long bytes
;
101 unsigned int curr_connections
;
102 unsigned int total_connections
;
103 unsigned int connection_structures
;
104 unsigned long long cmd_get
;
105 unsigned long long cmd_set
;
106 unsigned long long get_hits
;
107 unsigned long long get_misses
;
108 unsigned long long evictions
;
109 unsigned long long bytes_read
;
110 unsigned long long bytes_written
;
111 unsigned int limit_maxbytes
;
114 struct memcached_string_st
{
121 struct memcached_st
{
122 memcached_allocated is_allocated
;
123 memcached_server_st
*hosts
;
124 unsigned int number_of_hosts
;
125 unsigned int cursor_server
;
126 char read_buffer
[MEMCACHED_MAX_BUFFER
];
127 size_t read_buffer_length
;
129 char write_buffer
[MEMCACHED_MAX_BUFFER
];
130 size_t write_buffer_offset
;
133 unsigned long long flags
;
136 memcached_return warning
; /* Future Use */
140 memcached_st
*memcached_create(memcached_st
*ptr
);
141 void memcached_free(memcached_st
*ptr
);
143 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
145 memcached_return
memcached_increment(memcached_st
*ptr
,
146 char *key
, size_t key_length
,
148 unsigned int *value
);
149 memcached_return
memcached_decrement(memcached_st
*ptr
,
150 char *key
, size_t key_length
,
152 unsigned int *value
);
153 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
154 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
155 char *hostname
, unsigned int port
);
156 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
157 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
158 void memcached_quit(memcached_st
*ptr
);
159 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
160 memcached_return
memcached_behavior_set(memcached_st
*ptr
, memcached_behavior flag
, void *data
);
161 unsigned long long memcached_behavior_get(memcached_st
*ptr
, memcached_behavior flag
);
163 /* All of the functions for adding data to the server */
164 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
165 char *value
, size_t value_length
,
168 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
169 char *value
, size_t value_length
,
172 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
173 char *value
, size_t value_length
,
178 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
179 size_t *value_length
,
181 memcached_return
*error
);
182 memcached_return
memcached_mget(memcached_st
*ptr
,
183 char **keys
, size_t *key_length
,
184 unsigned int number_of_keys
);
185 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
186 size_t *value_length
, uint16_t *flags
,
187 memcached_return
*error
);
189 /* Server Public functions */
190 #define memcached_server_count(A) A->number_of_hosts
191 #define memcached_server_name(A,B) B.hostname
192 #define memcached_server_port(A,B) B.port
193 #define memcached_server_list(A) A->hosts
194 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
196 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
198 void memcached_server_list_free(memcached_server_st
*ptr
);
199 memcached_return
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
201 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
202 char *hostname
, unsigned int port
,
203 memcached_return
*error
);
204 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
205 memcached_server_st
*memcached_servers_parse(char *server_strings
);
207 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
208 char *key
, memcached_return
*error
);
209 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
210 memcached_return
*error
);
212 /* Some personal debugging functions */
213 #define WATCHPOINT printf("\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
214 #define WATCHPOINT_ERROR(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
215 #define WATCHPOINT_STRING(A) printf("\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
216 #define WATCHPOINT_NUMBER(A) printf("\nWATCHPOINT %s:%d (%s) %d\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
217 #define WATCHPOINT_ERRNO(A) printf("\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
224 #endif /* __MEMCACHED_H__ */