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