Ignore reclaimed stat
[m6w6/libmemcached] / libmemcached / memcached.h
1 /* LibMemcached
2 * Copyright (C) 2006-2009 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary: interface for memcached server
9 * Description: main include file for libmemcached
10 *
11 */
12
13 #ifndef __LIBMEMCACHED_MEMCACHED_H__
14 #define __LIBMEMCACHED_MEMCACHED_H__
15
16 #include <inttypes.h>
17 #include <netdb.h>
18 #include <netinet/in.h>
19 #include <stdlib.h>
20 #include <sys/types.h>
21
22
23 #if !defined(__cplusplus)
24 # include <stdbool.h>
25 #endif
26
27 #include <libmemcached/visibility.h>
28 #include <libmemcached/configure.h>
29 #include <libmemcached/constants.h>
30 #include <libmemcached/types.h>
31 #include <libmemcached/string.h>
32 #include <libmemcached/stats.h>
33 #include <libhashkit/hashkit.h>
34 // Everything above this line must be in the order specified.
35 #include <libmemcached/allocators.h>
36 #include <libmemcached/analyze.h>
37 #include <libmemcached/auto.h>
38 #include <libmemcached/behavior.h>
39 #include <libmemcached/callback.h>
40 #include <libmemcached/delete.h>
41 #include <libmemcached/dump.h>
42 #include <libmemcached/fetch.h>
43 #include <libmemcached/flush.h>
44 #include <libmemcached/flush_buffers.h>
45 #include <libmemcached/get.h>
46 #include <libmemcached/hash.h>
47 #include <libmemcached/parse.h>
48 #include <libmemcached/quit.h>
49 #include <libmemcached/result.h>
50 #include <libmemcached/server.h>
51 #include <libmemcached/storage.h>
52 #include <libmemcached/strerror.h>
53 #include <libmemcached/verbosity.h>
54 #include <libmemcached/version.h>
55
56 struct memcached_st {
57 /**
58 @note these are static and should not change without a call to behavior.
59 */
60 struct {
61 bool is_purging:1;
62 bool is_processing_input:1;
63 } state;
64 struct {
65 // Everything below here is pretty static.
66 bool auto_eject_hosts:1;
67 bool binary_protocol:1;
68 bool buffer_requests:1;
69 bool cork:1;
70 bool hash_with_prefix_key:1;
71 bool ketama_weighted:1;
72 bool no_block:1;
73 bool no_reply:1;
74 bool randomize_replica_read:1;
75 bool reuse_memory:1;
76 bool support_cas:1;
77 bool tcp_nodelay:1;
78 bool use_cache_lookups:1;
79 bool use_sort_hosts:1;
80 bool use_udp:1;
81 bool verify_key:1;
82 } flags;
83 memcached_server_distribution_t distribution;
84 hashkit_st hashkit;
85 uint32_t continuum_points_counter; // Ketama
86 uint32_t number_of_hosts;
87 memcached_server_st *servers;
88 memcached_server_st *last_disconnected_server;
89 int32_t snd_timeout;
90 int32_t rcv_timeout;
91 uint32_t server_failure_limit;
92 uint32_t io_msg_watermark;
93 uint32_t io_bytes_watermark;
94 uint32_t io_key_prefetch;
95 int cached_errno;
96 int32_t poll_timeout;
97 int32_t connect_timeout;
98 int32_t retry_timeout;
99 uint32_t continuum_count; // Ketama
100 int send_size;
101 int recv_size;
102 void *user_data;
103 time_t next_distribution_rebuild; // Ketama
104 size_t prefix_key_length;
105 uint32_t number_of_replicas;
106 hashkit_st distribution_hashkit;
107 memcached_result_st result;
108 memcached_continuum_item_st *continuum; // Ketama
109
110 struct _allocators_st {
111 memcached_calloc_fn calloc;
112 memcached_free_fn free;
113 memcached_malloc_fn malloc;
114 memcached_realloc_fn realloc;
115 void *context;
116 } allocators;
117
118 memcached_clone_fn on_clone;
119 memcached_cleanup_fn on_cleanup;
120 memcached_trigger_key_fn get_key_failure;
121 memcached_trigger_delete_key_fn delete_trigger;
122 memcached_callback_st *callbacks;
123 char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
124 struct {
125 bool is_allocated:1;
126 } options;
127
128 };
129
130 #ifdef __cplusplus
131 extern "C" {
132 #endif
133
134 LIBMEMCACHED_API
135 void memcached_servers_reset(memcached_st *ptr);
136
137 LIBMEMCACHED_API
138 memcached_st *memcached_create(memcached_st *ptr);
139
140 LIBMEMCACHED_API
141 void memcached_free(memcached_st *ptr);
142
143 LIBMEMCACHED_API
144 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr);
145
146 LIBMEMCACHED_API
147 void *memcached_get_user_data(const memcached_st *ptr);
148
149 LIBMEMCACHED_API
150 void *memcached_set_user_data(memcached_st *ptr, void *data);
151
152 #ifdef __cplusplus
153 } // extern "C"
154 #endif
155
156
157 // Local Only Inline
158 static inline memcached_server_st *memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key)
159 {
160 return &ptr->servers[server_key];
161 }
162
163 #ifdef __cplusplus
164 class Memcached : private memcached_st {
165 public:
166
167 Memcached()
168 {
169 memcached_create(this);
170 }
171
172 ~Memcached()
173 {
174 memcached_free(this);
175 }
176
177 Memcached(const Memcached& source)
178 {
179 memcached_clone(this, &source);
180 }
181
182 Memcached& operator=(const Memcached& source)
183 {
184 memcached_free(this);
185 memcached_clone(this, &source);
186
187 return *this;
188 }
189 };
190 #endif
191
192 #endif /* __LIBMEMCACHED_MEMCACHED_H__ */
193