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