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 // Everything above this line must be in the order specified.
  33 #include <libmemcached/analyze.h>
  34 #include <libmemcached/auto.h>
  35 #include <libmemcached/behavior.h>
  36 #include <libmemcached/callback.h>
  37 #include <libmemcached/dump.h>
  38 #include <libmemcached/get.h>
  39 #include <libmemcached/result.h>
  40 #include <libmemcached/server.h>
  41 #include <libmemcached/storage.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 struct memcached_st {
  48   struct {
  49     bool is_allocated:1;
  50     bool is_initialized:1;
  51     bool is_purging:1;
  52   } options;
  53   memcached_server_distribution_t distribution;
  54   memcached_hash_t hash;
  55   uint32_t continuum_points_counter; // Ketama
  56   memcached_server_st *hosts;
  57   memcached_server_st *last_disconnected_server;
  58   int32_t snd_timeout;
  59   int32_t rcv_timeout;
  60   uint32_t server_failure_limit;
  61   uint32_t io_msg_watermark;
  62   uint32_t io_bytes_watermark;
  63   uint32_t io_key_prefetch;
  64   uint32_t number_of_hosts;
  65   int cached_errno;
  66   struct {
  67     bool auto_eject_hosts:1;
  68     bool binary_protocol:1;
  69     bool buffer_requests:1;
  70     bool hash_with_prefix_key:1;
  71     bool ketama_weighted:1;
  72     bool no_block:1;
  73     bool no_reply:1;
  74     bool randomize_replica_read:1;
  75     bool reuse_memory:1;
  76     bool support_cas:1;
  77     bool tcp_nodelay:1;
  78     bool use_cache_lookups:1;
  79     bool use_sort_hosts:1;
  80     bool use_udp:1;
  81     bool verify_key:1;
  82   } flags;
  83   int32_t poll_timeout;
  84   int32_t connect_timeout;
  85   int32_t retry_timeout;
  86   uint32_t continuum_count; // Ketama
  87   int send_size;
  88   int recv_size;
  89   void *user_data;
  90   time_t next_distribution_rebuild; // Ketama
  91   size_t prefix_key_length;
  92   uint32_t number_of_replicas;
  93   memcached_hash_t distribution_hash;
  94   memcached_result_st result;
  95   memcached_continuum_item_st *continuum; // Ketama
  96   memcached_clone_fn on_clone;
  97   memcached_cleanup_fn on_cleanup;
  98   memcached_free_fn call_free;
  99   memcached_malloc_fn call_malloc;
 100   memcached_realloc_fn call_realloc;
 101   memcached_calloc_fn call_calloc;
 102   memcached_trigger_key_fn get_key_failure;
 103   memcached_trigger_delete_key_fn delete_trigger;
 104   memcached_callback_st *callbacks;
 105   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
 106 };
 107
 108 LIBMEMCACHED_API
 109 memcached_return_t memcached_version(memcached_st *ptr);
 110
 111 LIBMEMCACHED_API
 112 void memcached_servers_reset(memcached_st *ptr);
 113
 114 /* Public API */
 115
 116 LIBMEMCACHED_API
 117 const char * memcached_lib_version(void);
 118
 119 LIBMEMCACHED_API
 120 memcached_st *memcached_create(memcached_st *ptr);
 121 LIBMEMCACHED_API
 122 void memcached_free(memcached_st *ptr);
 123 LIBMEMCACHED_API
 124 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 125
 126 LIBMEMCACHED_API
 127 memcached_return_t memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
 128                                   time_t expiration);
 129
 130 LIBMEMCACHED_API
 131 memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration);
 132
 133 LIBMEMCACHED_API
 134 memcached_return_t memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 135
 136 LIBMEMCACHED_API
 137 void memcached_quit(memcached_st *ptr);
 138
 139 LIBMEMCACHED_API
 140 const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc);
 141
 142 /* The two public hash bits */
 143 LIBMEMCACHED_API
 144 uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash_t hash_algorithm);
 145
 146 LIBMEMCACHED_API
 147 uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
 148
 149 LIBMEMCACHED_API
 150 memcached_return_t memcached_flush_buffers(memcached_st *mem);
 151
 152 /* Server Public functions */
 153
 154 LIBMEMCACHED_API
 155 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
 156                                             const char *hostname,
 157                                             in_port_t port);
 158 LIBMEMCACHED_API
 159 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
 160                                                     const char *filename);
 161 LIBMEMCACHED_API
 162 memcached_return_t memcached_server_add(memcached_st *ptr,
 163                                         const char *hostname, in_port_t port);
 164
 165 LIBMEMCACHED_API
 166 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 167                                                         const char *hostname,
 168                                                         in_port_t port,
 169                                                         uint32_t weight);
 170 LIBMEMCACHED_API
 171 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 172                                                                 const char *filename,
 173                                                                 uint32_t weight);
 174 LIBMEMCACHED_API
 175 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 176                                                     in_port_t port,
 177                                                     uint32_t weight);
 178 LIBMEMCACHED_API
 179 void memcached_server_list_free(memcached_server_st *ptr);
 180
 181 LIBMEMCACHED_API
 182 memcached_return_t memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 183
 184 LIBMEMCACHED_API
 185 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 186                                                   const char *hostname,
 187                                                   in_port_t port,
 188                                                   memcached_return_t *error);
 189 LIBMEMCACHED_API
 190 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 191                                                               const char *hostname,
 192                                                               in_port_t port,
 193                                                               uint32_t weight,
 194                                                               memcached_return_t *error);
 195 LIBMEMCACHED_API
 196 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 197
 198 LIBMEMCACHED_API
 199 memcached_server_st *memcached_servers_parse(const char *server_strings);
 200
 201 LIBMEMCACHED_API
 202 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat,
 203                                const char *key, memcached_return_t *error);
 204 LIBMEMCACHED_API
 205 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat,
 206                                 memcached_return_t *error);
 207
 208 LIBMEMCACHED_API
 209 memcached_return_t memcached_delete_by_key(memcached_st *ptr,
 210                                            const char *master_key, size_t master_key_length,
 211                                            const char *key, size_t key_length,
 212                                            time_t expiration);
 213
 214 LIBMEMCACHED_API
 215 memcached_return_t memcached_fetch_execute(memcached_st *ptr,
 216                                            memcached_execute_fn *callback,
 217                                            void *context,
 218                                            unsigned int number_of_callbacks);
 219
 220 LIBMEMCACHED_API
 221 memcached_return_t memcached_set_memory_allocators(memcached_st *ptr,
 222                                                    memcached_malloc_fn mem_malloc,
 223                                                    memcached_free_fn mem_free,
 224                                                    memcached_realloc_fn mem_realloc,
 225                                                    memcached_calloc_fn mem_calloc);
 226
 227 LIBMEMCACHED_API
 228 void memcached_get_memory_allocators(memcached_st *ptr,
 229                                      memcached_malloc_fn *mem_malloc,
 230                                      memcached_free_fn *mem_free,
 231                                      memcached_realloc_fn *mem_realloc,
 232                                      memcached_calloc_fn *mem_calloc);
 233
 234 LIBMEMCACHED_API
 235 void *memcached_get_user_data(memcached_st *ptr);
 236 LIBMEMCACHED_API
 237 void *memcached_set_user_data(memcached_st *ptr, void *data);
 238
 239 LIBMEMCACHED_LOCAL
 240 memcached_return_t run_distribution(memcached_st *ptr);
 241
 242 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
 243 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
 244
 245 #ifdef __cplusplus
 246 }
 247 #endif
 248
 249
 250 #endif /* __MEMCACHED_H__ */