1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #ifndef __LIBMEMCACHED_MEMCACHED_H__
39 #define __LIBMEMCACHED_MEMCACHED_H__
43 #include <sys/types.h>
46 #if !defined(__cplusplus)
50 #include <libmemcached/visibility.h>
51 #include <libmemcached/configure.h>
52 #include <libmemcached/platform.h>
53 #include <libmemcached/constants.h>
54 #include <libmemcached/types.h>
55 #include <libmemcached/string.h>
56 #include <libmemcached/array.h>
57 #include <libmemcached/error.h>
58 #include <libmemcached/stats.h>
59 #include <libhashkit/hashkit.h>
60 // Everything above this line must be in the order specified.
61 #include <libmemcached/allocators.h>
62 #include <libmemcached/analyze.h>
63 #include <libmemcached/auto.h>
64 #include <libmemcached/behavior.h>
65 #include <libmemcached/callback.h>
66 #include <libmemcached/delete.h>
67 #include <libmemcached/dump.h>
68 #include <libmemcached/fetch.h>
69 #include <libmemcached/flush.h>
70 #include <libmemcached/flush_buffers.h>
71 #include <libmemcached/get.h>
72 #include <libmemcached/hash.h>
73 #include <libmemcached/options.h>
74 #include <libmemcached/parse.h>
75 #include <libmemcached/quit.h>
76 #include <libmemcached/result.h>
77 #include <libmemcached/server.h>
78 #include <libmemcached/server_list.h>
79 #include <libmemcached/storage.h>
80 #include <libmemcached/strerror.h>
81 #include <libmemcached/verbosity.h>
82 #include <libmemcached/version.h>
83 #include <libmemcached/sasl.h>
87 @note these are static and should not change without a call to behavior.
91 bool is_processing_input
:1;
92 bool is_time_for_rebuild
:1;
96 // Everything below here is pretty static.
97 bool auto_eject_hosts
:1;
98 bool binary_protocol
:1;
99 bool buffer_requests
:1;
100 bool hash_with_prefix_key
:1;
101 bool no_block
:1; // Don't block
103 bool randomize_replica_read
:1;
106 bool use_sort_hosts
:1;
109 bool tcp_keepalive
:1;
112 memcached_server_distribution_t distribution
;
114 uint32_t number_of_hosts
;
115 memcached_server_st
*servers
;
116 memcached_server_st
*last_disconnected_server
;
119 uint32_t server_failure_limit
;
120 uint32_t io_msg_watermark
;
121 uint32_t io_bytes_watermark
;
122 uint32_t io_key_prefetch
;
123 uint32_t tcp_keepidle
;
124 int32_t poll_timeout
;
125 int32_t connect_timeout
;
126 int32_t retry_timeout
;
131 uint32_t number_of_replicas
;
132 hashkit_st distribution_hashkit
;
133 memcached_result_st result
;
137 uint32_t continuum_count
; // Ketama
138 uint32_t continuum_points_counter
; // Ketama
139 time_t next_distribution_rebuild
; // Ketama
140 memcached_continuum_item_st
*continuum
; // Ketama
143 struct memcached_virtual_bucket_t
*virtual_bucket
;
145 struct _allocators_st
{
146 memcached_calloc_fn calloc
;
147 memcached_free_fn free
;
148 memcached_malloc_fn malloc
;
149 memcached_realloc_fn realloc
;
153 memcached_clone_fn on_clone
;
154 memcached_cleanup_fn on_cleanup
;
155 memcached_trigger_key_fn get_key_failure
;
156 memcached_trigger_delete_key_fn delete_trigger
;
157 memcached_callback_st
*callbacks
;
158 struct memcached_sasl_st sasl
;
159 struct memcached_error_st
*error_messages
;
160 struct memcached_array_st
*prefix_key
;
162 struct memcached_array_st
*filename
;
175 void memcached_servers_reset(memcached_st
*ptr
);
178 memcached_st
*memcached_create(memcached_st
*ptr
);
181 memcached_st
*memcached_create_with_options(const char *string
, size_t length
);
184 void memcached_free(memcached_st
*ptr
);
187 memcached_return_t
memcached_reset(memcached_st
*ptr
);
190 void memcached_reset_last_disconnected_server(memcached_st
*ptr
);
193 memcached_st
*memcached_clone(memcached_st
*clone
, const memcached_st
*ptr
);
196 void *memcached_get_user_data(const memcached_st
*ptr
);
199 void *memcached_set_user_data(memcached_st
*ptr
, void *data
);
202 memcached_return_t
memcached_push(memcached_st
*destination
, const memcached_st
*source
);
205 memcached_server_instance_st
memcached_server_instance_by_position(const memcached_st
*ptr
, uint32_t server_key
);
208 uint32_t memcached_server_count(const memcached_st
*);
214 #endif /* __LIBMEMCACHED_MEMCACHED_H__ */