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