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 */
45 MEMCACHED_HOST_LOCKUP_FAILURE
,
46 MEMCACHED_CONNECTION_FAILURE
,
47 MEMCACHED_CONNECTION_BIND_FAILURE
,
48 MEMCACHED_WRITE_FAILURE
,
49 MEMCACHED_READ_FAILURE
,
50 MEMCACHED_UNKNOWN_READ_FAILURE
,
51 MEMCACHED_PROTOCOL_ERROR
,
52 MEMCACHED_CLIENT_ERROR
,
53 MEMCACHED_SERVER_ERROR
,
54 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
55 MEMCACHED_DATA_EXISTS
,
56 MEMCACHED_DATA_DOES_NOT_EXIST
,
59 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
60 MEMCACHED_PARTIAL_READ
,
61 MEMCACHED_SOME_ERRORS
,
63 MEMCACHED_MAXIMUM_RETURN
, /* Always add new error code before */
67 MEMCACHED_NOT_ALLOCATED
= 0,
68 MEMCACHED_ALLOCATED
= 1,
69 } memcached_allocated
;
71 struct memcached_server_st
{
77 struct memcached_stat_st
{
83 unsigned int pointer_size
;
84 unsigned int rusage_user
;
85 unsigned int rusage_system
;
86 unsigned int rusage_user_seconds
;
87 unsigned int rusage_user_microseconds
;
88 unsigned int rusage_system_seconds
;
89 unsigned int rusage_system_microseconds
;
90 unsigned int curr_items
;
91 unsigned int total_items
;
92 unsigned long long bytes
;
93 unsigned int curr_connections
;
94 unsigned int total_connections
;
95 unsigned int connection_structures
;
96 unsigned long long cmd_get
;
97 unsigned long long cmd_set
;
98 unsigned long long get_hits
;
99 unsigned long long get_misses
;
100 unsigned long long evictions
;
101 unsigned long long bytes_read
;
102 unsigned long long bytes_written
;
103 unsigned int limit_maxbytes
;
106 struct memcached_string_st
{
113 struct memcached_st
{
114 memcached_allocated is_allocated
;
115 memcached_server_st
*hosts
;
116 unsigned int number_of_hosts
;
117 unsigned int cursor_server
;
122 memcached_st
*memcached_init(memcached_st
*ptr
);
123 void memcached_deinit(memcached_st
*ptr
);
125 memcached_return
memcached_delete(memcached_st
*ptr
, char *key
, size_t key_length
,
127 memcached_return
memcached_increment(memcached_st
*ptr
,
128 char *key
, size_t key_length
,
130 unsigned int *value
);
131 memcached_return
memcached_decrement(memcached_st
*ptr
,
132 char *key
, size_t key_length
,
134 unsigned int *value
);
135 memcached_stat_st
*memcached_stat(memcached_st
*ptr
, char *args
, memcached_return
*error
);
136 memcached_return
memcached_stat_servername(memcached_stat_st
*stat
, char *args
,
137 char *hostname
, unsigned int port
);
138 memcached_return
memcached_flush(memcached_st
*ptr
, time_t expiration
);
139 memcached_return
memcached_verbosity(memcached_st
*ptr
, unsigned int verbosity
);
140 void memcached_quit(memcached_st
*ptr
);
141 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
143 /* All of the functions for adding data to the server */
144 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
145 char *value
, size_t value_length
,
148 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
149 char *value
, size_t value_length
,
152 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
153 char *value
, size_t value_length
,
158 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
159 size_t *value_length
,
161 memcached_return
*error
);
162 memcached_return
memcached_mget(memcached_st
*ptr
,
163 char **keys
, size_t *key_length
,
164 unsigned int number_of_keys
);
165 char *memcached_fetch(memcached_st
*ptr
, char *key
, size_t *key_length
,
166 size_t *value_length
, uint16_t *flags
,
167 memcached_return
*error
);
169 /* Server Public functions */
170 #define memcached_server_count(A) A->number_of_hosts
171 #define memcached_server_name(A,B) B.hostname
172 #define memcached_server_port(A,B) B.port
173 #define memcached_server_list(A) A->hosts
175 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
,
178 /* These are all private, do not use. */
179 memcached_return
memcached_connect(memcached_st
*ptr
);
180 memcached_return
memcached_response(memcached_st
*ptr
,
181 char *buffer
, size_t buffer_length
,
182 unsigned int server_key
);
183 unsigned int memcached_generate_hash(char *key
, size_t key_length
);
184 char *memcached_stat_get_value(memcached_st
*ptr
, memcached_stat_st
*stat
,
185 char *key
, memcached_return
*error
);
186 char ** memcached_stat_get_keys(memcached_st
*ptr
, memcached_stat_st
*stat
,
187 memcached_return
*error
);
191 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
192 #define memcached_string_size(A, B) B->current_size
193 #define memcached_string_value(A, B) B->string
195 memcached_string_st
*memcached_string_init(memcached_st
*ptr
, size_t initial_size
);
196 memcached_return
memcached_string_append_character(memcached_st
*ptr
,
197 memcached_string_st
*string
,
199 memcached_return
memcached_string_append(memcached_st
*ptr
, memcached_string_st
*string
,
200 char *value
, size_t length
);
201 size_t memcached_string_backspace(memcached_st
*ptr
, memcached_string_st
*string
, size_t remove
);
202 memcached_return
memcached_string_reset(memcached_st
*ptr
, memcached_string_st
*string
);
203 void memcached_string_free(memcached_st
*ptr
, memcached_string_st
*string
);
205 /* Some personal debugging functions */
206 #define WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout);
207 #define WATCHPOINT_ERROR(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
214 #endif /* __MEMCACHED_H__ */