git.m6w6.name Git - awesomized/libmemcached/blob - 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 /* string value */
 106 struct memcached_continuum_item_st
 107 {
 108   uint32_t index;
 109   uint32_t value;
 110 };
 111
 112 #if !defined(__GNUC__) || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
 113
 114 #define likely(x)       if((x))
 115 #define unlikely(x)     if((x))
 116
 117 #else
 118
 119 #define likely(x)       if(__builtin_expect((x) != 0, 1))
 120 #define unlikely(x)     if(__builtin_expect((x) != 0, 0))
 121 #endif
 122
 123 #define MEMCACHED_BLOCK_SIZE 1024
 124 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
 125 #define SMALL_STRING_LEN 1024
 126 #define HUGE_STRING_LEN 8196
 127
 128 #ifdef __cplusplus
 129 extern "C" {
 130 #endif
 131
 132 LIBMEMCACHED_LOCAL
 133 memcached_return_t memcached_connect(memcached_server_write_instance_st ptr);
 134
 135 LIBMEMCACHED_LOCAL
 136 memcached_return_t run_distribution(memcached_st *ptr);
 137
 138 #define memcached_server_response_increment(A) (A)->cursor_active++
 139 #define memcached_server_response_decrement(A) (A)->cursor_active--
 140 #define memcached_server_response_reset(A) (A)->cursor_active=0
 141
 142 LIBMEMCACHED_LOCAL
 143 void set_last_disconnected_host(memcached_server_write_instance_st ptr);
 144
 145 #ifdef __cplusplus
 146 LIBMEMCACHED_LOCAL
 147 memcached_return_t memcached_key_test(const memcached_st& memc,
 148                                       const char * const *keys,
 149                                       const size_t *key_length,
 150                                       size_t number_of_keys);
 151 #endif
 152
 153 LIBMEMCACHED_LOCAL
 154 memcached_return_t memcached_purge(memcached_server_write_instance_st ptr);
 155
 156 LIBMEMCACHED_LOCAL
 157   memcached_server_st *__server_create_with(const memcached_st *memc,
 158                                             memcached_server_write_instance_st host,
 159                                             const char *hostname,
 160                                             in_port_t port,
 161                                             uint32_t weight,
 162                                             memcached_connection_t type);
 163
 164
 165 static inline memcached_return_t memcached_validate_key_length(size_t key_length, bool binary)
 166 {
 167   unlikely (key_length == 0)
 168   {
 169     return MEMCACHED_BAD_KEY_PROVIDED;
 170   }
 171
 172   if (binary)
 173   {
 174     unlikely (key_length > 0xffff)
 175       return MEMCACHED_BAD_KEY_PROVIDED;
 176   }
 177   else
 178   {
 179     unlikely (key_length >= MEMCACHED_MAX_KEY)
 180       return MEMCACHED_BAD_KEY_PROVIDED;
 181   }
 182
 183   return MEMCACHED_SUCCESS;
 184 }
 185
 186 #ifdef __cplusplus
 187 }
 188 #endif