Merge up for version.
[awesomized/libmemcached] / libmemcached / common.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * LibMemcached
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39 /*
40 Common include file for libmemached
41 */
42
43 #pragma once
44
45 #include <config.h>
46
47 #ifdef __cplusplus
48 #include <cstdio>
49 #include <cstdlib>
50 #include <cstring>
51 #include <ctime>
52 #include <ctype.h>
53 #else
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <time.h>
58 #endif
59
60 #include <errno.h>
61 #include <fcntl.h>
62 #include <limits.h>
63 #include <sys/types.h>
64 #include <unistd.h>
65
66 #include <libmemcached/memcached.h>
67 #include <libmemcached/watchpoint.h>
68 #include <libmemcached/is.h>
69 #include <libmemcached/namespace.h>
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75 typedef struct memcached_server_st * memcached_server_write_instance_st;
76
77 typedef memcached_return_t (*memcached_server_execute_fn)(memcached_st *ptr, memcached_server_write_instance_st server, void *context);
78
79 LIBMEMCACHED_LOCAL
80 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key);
81
82 LIBMEMCACHED_LOCAL
83 memcached_return_t memcached_server_execute(memcached_st *ptr,
84 memcached_server_execute_fn callback,
85 void *context);
86 #ifdef __cplusplus
87 } // extern "C"
88 #endif
89
90
91 /* These are private not to be installed headers */
92 #include <libmemcached/error.hpp>
93 #include <libmemcached/memory.h>
94 #include <libmemcached/io.h>
95 #include <libmemcached/do.hpp>
96 #include <libmemcached/internal.h>
97 #include <libmemcached/array.h>
98 #include <libmemcached/libmemcached_probes.h>
99 #include <libmemcached/memcached/protocol_binary.h>
100 #include <libmemcached/byteorder.h>
101 #include <libmemcached/initialize_query.h>
102 #include <libmemcached/response.h>
103 #include <libmemcached/namespace.h>
104
105 #ifdef __cplusplus
106 #include <libmemcached/backtrace.hpp>
107 #include <libmemcached/assert.hpp>
108 #endif
109
110 /* string value */
111 struct memcached_continuum_item_st
112 {
113 uint32_t index;
114 uint32_t value;
115 };
116
117 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
118
119 #define likely(x) if((x))
120 #define unlikely(x) if((x))
121
122 #else
123
124 #define likely(x) if(__builtin_expect((x) != 0, 1))
125 #define unlikely(x) if(__builtin_expect((x) != 0, 0))
126 #endif
127
128 #define MEMCACHED_BLOCK_SIZE 1024
129 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
130 #define SMALL_STRING_LEN 1024
131 #define HUGE_STRING_LEN 8196
132
133 #ifdef __cplusplus
134 extern "C" {
135 #endif
136
137 LIBMEMCACHED_LOCAL
138 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
139
140 LIBMEMCACHED_LOCAL
141 memcached_return_t run_distribution(memcached_st *ptr);
142
143 #define memcached_server_response_increment(A) (A)->cursor_active++
144 #define memcached_server_response_decrement(A) (A)->cursor_active--
145 #define memcached_server_response_reset(A) (A)->cursor_active=0
146
147 LIBMEMCACHED_LOCAL
148 void set_last_disconnected_host(memcached_server_write_instance_st ptr);
149
150 #ifdef __cplusplus
151 LIBMEMCACHED_LOCAL
152 memcached_return_t memcached_key_test(const memcached_st& memc,
153 const char * const *keys,
154 const size_t *key_length,
155 size_t number_of_keys);
156 #endif
157
158 LIBMEMCACHED_LOCAL
159 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
160
161 LIBMEMCACHED_LOCAL
162 memcached_server_st *__server_create_with(const memcached_st *memc,
163 memcached_server_write_instance_st host,
164 const char *hostname,
165 in_port_t port,
166 uint32_t weight,
167 memcached_connection_t type);
168
169
170 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
171 {
172 if (key_length == 0)
173 {
174 return MEMCACHED_BAD_KEY_PROVIDED;
175 }
176
177 if (binary)
178 {
179 if (key_length > 0xffff)
180 {
181 return MEMCACHED_BAD_KEY_PROVIDED;
182 }
183 }
184 else
185 {
186 if (key_length >= MEMCACHED_MAX_KEY)
187 {
188 return MEMCACHED_BAD_KEY_PROVIDED;
189 }
190 }
191
192 return MEMCACHED_SUCCESS;
193 }
194
195 #ifdef __cplusplus
196 }
197 #endif