Cleanup of behavior (refactored...)
[awesomized/libmemcached] / include / memcached.h
1 /*
2 * Summary: interface for memcached server
3 * Description: main include file for libmemcached
4 *
5 * Copy: See Copyright for the status of this software.
6 *
7 * Author: Brian Aker
8 */
9
10 #ifndef __MEMCACHED_H__
11 #define __MEMCACHED_H__
12
13 #include <stdio.h>
14 #include <stdlib.h>
15 #include <string.h>
16 #include <sys/types.h>
17 #include <sys/socket.h>
18 #include <netinet/in.h>
19 #include <arpa/inet.h>
20 #include <netdb.h>
21 #include <unistd.h>
22 #include <limits.h>
23 #include <assert.h>
24 #include <time.h>
25 #include <errno.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
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;
35
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
43
44 typedef enum {
45 MEMCACHED_SUCCESS,
46 MEMCACHED_FAILURE,
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,
59 MEMCACHED_NOTSTORED,
60 MEMCACHED_STORED,
61 MEMCACHED_NOTFOUND,
62 MEMCACHED_MEMORY_ALLOCATION_FAILURE,
63 MEMCACHED_PARTIAL_READ,
64 MEMCACHED_SOME_ERRORS,
65 MEMCACHED_NO_SERVERS,
66 MEMCACHED_END,
67 MEMCACHED_DELETED,
68 MEMCACHED_VALUE,
69 MEMCACHED_STAT,
70 MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
71 } memcached_return;
72
73 typedef enum {
74 MEMCACHED_BEHAVIOR_NO_BLOCK,
75 MEMCACHED_BEHAVIOR_TCP_NODELAY,
76 MEMCACHED_BEHAVIOR_MD5_HASHING,
77 MEMCACHED_BEHAVIOR_KETAMA,
78 } memcached_behavior;
79
80 typedef enum {
81 MEMCACHED_NOT_ALLOCATED= 0,
82 MEMCACHED_ALLOCATED= 1,
83 } memcached_allocated;
84
85 struct memcached_server_st {
86 char *hostname;
87 unsigned int port;
88 int fd;
89 };
90
91 struct memcached_stat_st {
92 unsigned int pid;
93 unsigned int uptime;
94 unsigned int threads;
95 time_t time;
96 char version[8];
97 unsigned int pointer_size;
98 unsigned int rusage_user;
99 unsigned int rusage_system;
100 unsigned int rusage_user_seconds;
101 unsigned int rusage_user_microseconds;
102 unsigned int rusage_system_seconds;
103 unsigned int rusage_system_microseconds;
104 unsigned int curr_items;
105 unsigned int total_items;
106 unsigned long long bytes;
107 unsigned int curr_connections;
108 unsigned int total_connections;
109 unsigned int connection_structures;
110 unsigned long long cmd_get;
111 unsigned long long cmd_set;
112 unsigned long long get_hits;
113 unsigned long long get_misses;
114 unsigned long long evictions;
115 unsigned long long bytes_read;
116 unsigned long long bytes_written;
117 unsigned int limit_maxbytes;
118 };
119
120 struct memcached_string_st {
121 char *string;
122 char *end;
123 size_t current_size;
124 size_t block_size;
125 };
126
127 struct memcached_st {
128 memcached_allocated is_allocated;
129 memcached_server_st *hosts;
130 unsigned int number_of_hosts;
131 unsigned int cursor_server;
132 char read_buffer[MEMCACHED_MAX_BUFFER];
133 size_t read_buffer_length;
134 char *read_ptr;
135 char write_buffer[MEMCACHED_MAX_BUFFER];
136 size_t write_buffer_offset;
137 char connected;
138 int my_errno;
139 unsigned int stack_responses;
140 unsigned long long flags;
141 memcached_return warning; /* Future Use */
142 };
143
144 /* Public API */
145 memcached_st *memcached_create(memcached_st *ptr);
146 void memcached_free(memcached_st *ptr);
147
148 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
149 time_t expiration);
150 memcached_return memcached_increment(memcached_st *ptr,
151 char *key, size_t key_length,
152 unsigned int offset,
153 unsigned int *value);
154 memcached_return memcached_decrement(memcached_st *ptr,
155 char *key, size_t key_length,
156 unsigned int offset,
157 unsigned int *value);
158 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
159 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
160 char *hostname, unsigned int port);
161 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
162 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
163 void memcached_quit(memcached_st *ptr);
164 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
165 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
166 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
167
168 /* All of the functions for adding data to the server */
169 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
170 char *value, size_t value_length,
171 time_t expiration,
172 uint16_t flags);
173 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
174 char *value, size_t value_length,
175 time_t expiration,
176 uint16_t flags);
177 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
178 char *value, size_t value_length,
179 time_t expiration,
180 uint16_t flags);
181
182 /* Get functions */
183 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
184 size_t *value_length,
185 uint16_t *flags,
186 memcached_return *error);
187 memcached_return memcached_mget(memcached_st *ptr,
188 char **keys, size_t *key_length,
189 unsigned int number_of_keys);
190 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
191 size_t *value_length, uint16_t *flags,
192 memcached_return *error);
193
194 /* Server Public functions */
195 #define memcached_server_count(A) A->number_of_hosts
196 #define memcached_server_name(A,B) B.hostname
197 #define memcached_server_port(A,B) B.port
198 #define memcached_server_list(A) A->hosts
199
200 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
201 unsigned int port);
202
203 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
204 char *hostname, unsigned int port,
205 memcached_return *error);
206 void memcached_server_list_free(memcached_server_st *ptr);
207 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
208 unsigned int memcached_server_list_count(memcached_server_st *ptr);
209 memcached_server_st *memcached_servers_parse(char *server_strings);
210
211 /* String Struct */
212 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
213 #define memcached_string_size(A, B) B->current_size
214 #define memcached_string_value(A, B) B->string
215
216 memcached_string_st *memcached_string_create(memcached_st *ptr, size_t initial_size);
217 memcached_return memcached_string_append_character(memcached_st *ptr,
218 memcached_string_st *string,
219 char character);
220 memcached_return memcached_string_append(memcached_st *ptr, memcached_string_st *string,
221 char *value, size_t length);
222 size_t memcached_string_backspace(memcached_st *ptr, memcached_string_st *string, size_t remove);
223 memcached_return memcached_string_reset(memcached_st *ptr, memcached_string_st *string);
224 void memcached_string_free(memcached_st *ptr, memcached_string_st *string);
225
226 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
227 char *key, memcached_return *error);
228 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
229 memcached_return *error);
230
231 /* Some personal debugging functions */
232 #define WATCHPOINT printf("\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
233 #define WATCHPOINT_ERROR(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
234 #define WATCHPOINT_STRING(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
235 #define WATCHPOINT_NUMBER(A) printf("\nWATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
236 #define WATCHPOINT_ERRNO(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, strerror(A));A= 0;fflush(stdout);
237
238
239 #ifdef __cplusplus
240 }
241 #endif
242
243 #endif /* __MEMCACHED_H__ */