git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached.h

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Libmemcached library
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions are
  10  *  met:
  11  *
  12  *      * Redistributions of source code must retain the above copyright
  13  *  notice, this list of conditions and the following disclaimer.
  14  *
  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
  18  *  distribution.
  19  *
  20  *      * The names of its contributors may not be used to endorse or
  21  *  promote products derived from this software without specific prior
  22  *  written permission.
  23  *
  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.
  35  *
  36  */
  37
  38 #pragma once
  39
  40 #include <inttypes.h>
  41 #include <stdlib.h>
  42 #include <sys/types.h>
  43
  44
  45 #if !defined(__cplusplus)
  46 # include <stdbool.h>
  47 #endif
  48
  49 #include <libmemcached/visibility.h>
  50 #include <libmemcached/configure.h>
  51 #include <libmemcached/platform.h>
  52 #include <libmemcached/constants.h>
  53 #include <libmemcached/return.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
  61 // Everything above this line must be in the order specified.
  62 #include <libmemcached/allocators.h>
  63 #include <libmemcached/analyze.h>
  64 #include <libmemcached/auto.h>
  65 #include <libmemcached/behavior.h>
  66 #include <libmemcached/callback.h>
  67 #include <libmemcached/delete.h>
  68 #include <libmemcached/dump.h>
  69 #include <libmemcached/fetch.h>
  70 #include <libmemcached/flush.h>
  71 #include <libmemcached/flush_buffers.h>
  72 #include <libmemcached/get.h>
  73 #include <libmemcached/hash.h>
  74 #include <libmemcached/options.h>
  75 #include <libmemcached/parse.h>
  76 #include <libmemcached/quit.h>
  77 #include <libmemcached/result.h>
  78 #include <libmemcached/server.h>
  79 #include <libmemcached/server_list.h>
  80 #include <libmemcached/storage.h>
  81 #include <libmemcached/strerror.h>
  82 #include <libmemcached/verbosity.h>
  83 #include <libmemcached/version.h>
  84 #include <libmemcached/sasl.h>
  85
  86 struct memcached_st {
  87   /**
  88     @note these are static and should not change without a call to behavior.
  89   */
  90   struct {
  91     bool is_purging:1;
  92     bool is_processing_input:1;
  93     bool is_time_for_rebuild:1;
  94   } state;
  95
  96   struct {
  97     // Everything below here is pretty static.
  98     bool auto_eject_hosts:1;
  99     bool binary_protocol:1;
 100     bool buffer_requests:1;
 101     bool hash_with_namespace:1;
 102     bool no_block:1; // Don't block
 103     bool no_reply:1;
 104     bool randomize_replica_read:1;
 105     bool support_cas:1;
 106     bool tcp_nodelay:1;
 107     bool use_sort_hosts:1;
 108     bool use_udp:1;
 109     bool verify_key:1;
 110     bool tcp_keepalive:1;
 111   } flags;
 112
 113   memcached_server_distribution_t distribution;
 114   hashkit_st hashkit;
 115   uint32_t number_of_hosts;
 116   memcached_server_st *servers;
 117   memcached_server_st *last_disconnected_server;
 118   int32_t snd_timeout;
 119   int32_t rcv_timeout;
 120   uint32_t server_failure_limit;
 121   uint32_t io_msg_watermark;
 122   uint32_t io_bytes_watermark;
 123   uint32_t io_key_prefetch;
 124   uint32_t tcp_keepidle;
 125   int32_t poll_timeout;
 126   int32_t connect_timeout;
 127   int32_t retry_timeout;
 128   int send_size;
 129   int recv_size;
 130   void *user_data;
 131   uint64_t query_id;
 132   uint32_t number_of_replicas;
 133   memcached_result_st result;
 134
 135   struct {
 136     bool weighted;
 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
 141   } ketama;
 142
 143   struct memcached_virtual_bucket_t *virtual_bucket;
 144
 145   struct memcached_allocator_t allocators;
 146
 147   memcached_clone_fn on_clone;
 148   memcached_cleanup_fn on_cleanup;
 149   memcached_trigger_key_fn get_key_failure;
 150   memcached_trigger_delete_key_fn delete_trigger;
 151   memcached_callback_st *callbacks;
 152   struct memcached_sasl_st sasl;
 153   struct memcached_error_t *error_messages;
 154   struct memcached_array_st *_namespace;
 155   struct {
 156     uint32_t initial_pool_size;
 157     uint32_t max_pool_size;
 158     int32_t version; // This is used by pool and others to determine if the memcached_st is out of date.
 159     struct memcached_array_st *filename;
 160   } configure;
 161   struct {
 162     bool is_allocated:1;
 163   } options;
 164
 165 };
 166
 167 #ifdef __cplusplus
 168 extern "C" {
 169 #endif
 170
 171 LIBMEMCACHED_API
 172 void memcached_servers_reset(memcached_st *ptr);
 173
 174 LIBMEMCACHED_API
 175 memcached_st *memcached_create(memcached_st *ptr);
 176
 177 LIBMEMCACHED_API
 178 memcached_st *memcached(const char *string, size_t string_length);
 179
 180 LIBMEMCACHED_API
 181 void memcached_free(memcached_st *ptr);
 182
 183 LIBMEMCACHED_API
 184 memcached_return_t memcached_reset(memcached_st *ptr);
 185
 186 LIBMEMCACHED_API
 187 void memcached_reset_last_disconnected_server(memcached_st *ptr);
 188
 189 LIBMEMCACHED_API
 190 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr);
 191
 192 LIBMEMCACHED_API
 193 void *memcached_get_user_data(const memcached_st *ptr);
 194
 195 LIBMEMCACHED_API
 196 void *memcached_set_user_data(memcached_st *ptr, void *data);
 197
 198 LIBMEMCACHED_API
 199 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source);
 200
 201 LIBMEMCACHED_API
 202 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key);
 203
 204 LIBMEMCACHED_API
 205 uint32_t memcached_server_count(const memcached_st *);
 206
 207 LIBMEMCACHED_API
 208 uint64_t memcached_query_id(const memcached_st *);
 209
 210 #ifdef __cplusplus
 211 } // extern "C"
 212 #endif