3 * Summary: interface for memcached server
4 * Description: main include file for libmemcached
6 * Copy: See Copyright for the status of this software.
11 #ifndef __MEMCACHED_H__
12 #define __MEMCACHED_H__
17 #include <sys/types.h>
18 #include <sys/socket.h>
19 #include <netinet/in.h>
20 #include <arpa/inet.h>
32 typedef struct memcached_st memcached_st
;
33 typedef struct memcached_stat_st memcached_stat_st
;
34 typedef struct memcached_host_st memcached_host_st
;
36 #define MEMCACHED_DEFAULT_PORT 11211
37 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
38 #define HUGE_STRING_LEN 8196
43 MEMCACHED_HOST_LOCKUP_FAILURE
,
44 MEMCACHED_CONNECTION_FAILURE
,
45 MEMCACHED_CONNECTION_BIND_FAILURE
,
46 MEMCACHED_WRITE_FAILURE
,
47 MEMCACHED_READ_FAILURE
,
48 MEMCACHED_UNKNOWN_READ_FAILURE
,
49 MEMCACHED_PROTOCOL_ERROR
,
50 MEMCACHED_CLIENT_ERROR
,
51 MEMCACHED_SERVER_ERROR
,
52 MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
,
53 MEMCACHED_DATA_EXISTS
,
54 MEMCACHED_DATA_DOES_NOT_EXIST
,
57 MEMCACHED_MEMORY_ALLOCATION_FAILURE
,
58 MEMCACHED_PARTIAL_READ
,
59 MEMCACHED_SOME_ERRORS
,
63 MEMCACHED_NOT_ALLOCATED
= 0,
64 MEMCACHED_ALLOCATED
= 1,
65 } memcached_allocated
;
67 struct memcached_host_st
{
73 struct memcached_stat_st
{
79 unsigned int pointer_size
;
80 unsigned int rusage_user
;
81 unsigned int rusage_system
;
82 unsigned int rusage_user_seconds
;
83 unsigned int rusage_user_microseconds
;
84 unsigned int rusage_system_seconds
;
85 unsigned int rusage_system_microseconds
;
86 unsigned int curr_items
;
87 unsigned int total_items
;
88 unsigned long long bytes
;
89 unsigned int curr_connections
;
90 unsigned int total_connections
;
91 unsigned int connection_structures
;
92 unsigned long long cmd_get
;
93 unsigned long long cmd_set
;
94 unsigned long long get_hits
;
95 unsigned long long get_misses
;
96 unsigned long long evictions
;
97 unsigned long long bytes_read
;
98 unsigned long long bytes_written
;
99 unsigned int limit_maxbytes
;
102 struct memcached_st
{
103 memcached_allocated is_allocated
;
104 memcached_host_st
*hosts
;
105 unsigned int number_of_hosts
;
110 memcached_st
*memcached_init(memcached_st
*ptr
);
111 void memcached_deinit(memcached_st
*ptr
);
113 memcached_return
memcached_set(memcached_st
*ptr
, char *key
, size_t key_length
,
114 char *value
, size_t value_length
,
117 memcached_return
memcached_add(memcached_st
*ptr
, char *key
, size_t key_length
,
118 char *value
, size_t value_length
,
121 memcached_return
memcached_replace(memcached_st
*ptr
, char *key
, size_t key_length
,
122 char *value
, size_t value_length
,
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_hostname(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 memcached_return
memcached_quit(memcached_st
*ptr
, char *hostname
, unsigned port
);
141 char *memcached_get(memcached_st
*ptr
, char *key
, size_t key_length
,
142 size_t *value_length
,
144 memcached_return
*error
);
145 memcached_return
memcached_server_add(memcached_st
*ptr
, char *hostname
, unsigned int port
);
146 char *memcached_strerror(memcached_st
*ptr
, memcached_return rc
);
148 /* These are all private, do not use. */
149 memcached_return
memcached_connect(memcached_st
*ptr
);
150 memcached_return
memcached_response(memcached_st
*ptr
,
151 char *buffer
, size_t buffer_length
,
152 unsigned int server_key
);
153 unsigned int memcached_generate_hash(char *key
, size_t key_length
);
159 #endif /* __MEMCACHED_H__ */