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