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

   1 /*
   2  * Summary: interface for memcached server
   3  * Description: main include file for libmemcached
   4  *
   5  * Copy: See Copyright for the status of this software.
   6  *
   7  * Author: Brian Aker
   8  */
   9
  10 #ifndef __MEMCACHED_H__
  11 #define __MEMCACHED_H__
  12
  13 #include <stdlib.h>
  14 #include <inttypes.h>
  15 #if !defined(__cplusplus)
  16 # include <stdbool.h>
  17 #endif
  18 #include <sys/types.h>
  19 #include <netinet/in.h>
  20
  21 #include <libmemcached/visibility.h>
  22 #include <libmemcached/memcached_configure.h>
  23 #include <libmemcached/memcached_constants.h>
  24 #include <libmemcached/memcached_types.h>
  25 #include <libmemcached/memcached_get.h>
  26 #include <libmemcached/memcached_server.h>
  27 #include <libmemcached/memcached_string.h>
  28 #include <libmemcached/memcached_result.h>
  29 #include <libmemcached/memcached_storage.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #define MEMCACHED_VERSION_STRING_LENGTH 24
  36
  37 struct memcached_analysis_st {
  38   uint32_t average_item_size;
  39   uint32_t longest_uptime;
  40   uint32_t least_free_server;
  41   uint32_t most_consumed_server;
  42   uint32_t oldest_server;
  43   double pool_hit_ratio;
  44   uint64_t most_used_bytes;
  45   uint64_t least_remaining_bytes;
  46 };
  47
  48 struct memcached_stat_st {
  49   uint32_t connection_structures;
  50   uint32_t curr_connections;
  51   uint32_t curr_items;
  52   uint32_t pid;
  53   uint32_t pointer_size;
  54   uint32_t rusage_system_microseconds;
  55   uint32_t rusage_system_seconds;
  56   uint32_t rusage_user_microseconds;
  57   uint32_t rusage_user_seconds;
  58   uint32_t threads;
  59   uint32_t time;
  60   uint32_t total_connections;
  61   uint32_t total_items;
  62   uint32_t uptime;
  63   uint64_t bytes;
  64   uint64_t bytes_read;
  65   uint64_t bytes_written;
  66   uint64_t cmd_get;
  67   uint64_t cmd_set;
  68   uint64_t evictions;
  69   uint64_t get_hits;
  70   uint64_t get_misses;
  71   uint64_t limit_maxbytes;
  72   char version[MEMCACHED_VERSION_STRING_LENGTH];
  73 };
  74
  75 struct memcached_st {
  76   uint8_t purging;
  77   bool is_allocated;
  78   uint8_t distribution;
  79   uint8_t hash;
  80   uint32_t continuum_points_counter;
  81   memcached_server_st *hosts;
  82   memcached_server_st *last_disconnected_server;
  83   int32_t snd_timeout;
  84   int32_t rcv_timeout;
  85   uint32_t server_failure_limit;
  86   uint32_t io_msg_watermark;
  87   uint32_t io_bytes_watermark;
  88   uint32_t io_key_prefetch;
  89   uint32_t number_of_hosts;
  90   uint32_t cursor_server;
  91   int cached_errno;
  92   uint32_t flags;
  93   int32_t poll_timeout;
  94   int32_t connect_timeout;
  95   int32_t retry_timeout;
  96   uint32_t continuum_count;
  97   int send_size;
  98   int recv_size;
  99   void *user_data;
 100   time_t next_distribution_rebuild;
 101   size_t prefix_key_length;
 102   memcached_hash hash_continuum;
 103   memcached_result_st result;
 104   memcached_continuum_item_st *continuum;
 105   memcached_clone_func on_clone;
 106   memcached_cleanup_func on_cleanup;
 107   memcached_free_function call_free;
 108   memcached_malloc_function call_malloc;
 109   memcached_realloc_function call_realloc;
 110   memcached_calloc_function call_calloc;
 111   memcached_trigger_key get_key_failure;
 112   memcached_trigger_delete_key delete_trigger;
 113   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
 114   uint32_t number_of_replicas;
 115   memcached_callback_st *callbacks;
 116 };
 117
 118 LIBMEMCACHED_API
 119 memcached_return memcached_version(memcached_st *ptr);
 120
 121 /* Public API */
 122
 123 LIBMEMCACHED_API
 124 const char * memcached_lib_version(void);
 125
 126 LIBMEMCACHED_API
 127 memcached_st *memcached_create(memcached_st *ptr);
 128 LIBMEMCACHED_API
 129 void memcached_free(memcached_st *ptr);
 130 LIBMEMCACHED_API
 131 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 132
 133 LIBMEMCACHED_API
 134 memcached_return memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
 135                                   time_t expiration);
 136 LIBMEMCACHED_API
 137 memcached_return memcached_increment(memcached_st *ptr,
 138                                      const char *key, size_t key_length,
 139                                      uint32_t offset,
 140                                      uint64_t *value);
 141 LIBMEMCACHED_API
 142 memcached_return memcached_decrement(memcached_st *ptr,
 143                                      const char *key, size_t key_length,
 144                                      uint32_t offset,
 145                                      uint64_t *value);
 146
 147 LIBMEMCACHED_API
 148 memcached_return memcached_increment_by_key(memcached_st *ptr,
 149                                             const char *master_key, size_t master_key_length,
 150                                             const char *key, size_t key_length,
 151                                             uint64_t offset,
 152                                             uint64_t *value);
 153
 154 LIBMEMCACHED_API
 155 memcached_return memcached_decrement_by_key(memcached_st *ptr,
 156                                             const char *master_key, size_t master_key_length,
 157                                             const char *key, size_t key_length,
 158                                             uint64_t offset,
 159                                             uint64_t *value);
 160
 161 LIBMEMCACHED_API
 162 memcached_return memcached_increment_with_initial(memcached_st *ptr,
 163                                                   const char *key,
 164                                                   size_t key_length,
 165                                                   uint64_t offset,
 166                                                   uint64_t initial,
 167                                                   time_t expiration,
 168                                                   uint64_t *value);
 169 LIBMEMCACHED_API
 170 memcached_return memcached_decrement_with_initial(memcached_st *ptr,
 171                                                   const char *key,
 172                                                   size_t key_length,
 173                                                   uint64_t offset,
 174                                                   uint64_t initial,
 175                                                   time_t expiration,
 176                                                   uint64_t *value);
 177 LIBMEMCACHED_API
 178 memcached_return memcached_increment_with_initial_by_key(memcached_st *ptr,
 179                                                          const char *master_key,
 180                                                          size_t master_key_length,
 181                                                          const char *key,
 182                                                          size_t key_length,
 183                                                          uint64_t offset,
 184                                                          uint64_t initial,
 185                                                          time_t expiration,
 186                                                          uint64_t *value);
 187 LIBMEMCACHED_API
 188 memcached_return memcached_decrement_with_initial_by_key(memcached_st *ptr,
 189                                                          const char *master_key,
 190                                                          size_t master_key_length,
 191                                                          const char *key,
 192                                                          size_t key_length,
 193                                                          uint64_t offset,
 194                                                          uint64_t initial,
 195                                                          time_t expiration,
 196                                                          uint64_t *value);
 197 LIBMEMCACHED_API
 198 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 199 LIBMEMCACHED_API
 200 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 201 LIBMEMCACHED_API
 202 memcached_return memcached_stat_servername(memcached_stat_st *memc_stat, char *args,
 203                                            char *hostname, unsigned int port);
 204 LIBMEMCACHED_API
 205 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 206 LIBMEMCACHED_API
 207 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 208 LIBMEMCACHED_API
 209 void memcached_quit(memcached_st *ptr);
 210 LIBMEMCACHED_API
 211 const char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 212 LIBMEMCACHED_API
 213 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
 214 LIBMEMCACHED_API
 215 uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 216
 217 /* The two public hash bits */
 218 LIBMEMCACHED_API
 219 uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash hash_algorithm);
 220 LIBMEMCACHED_API
 221 uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
 222
 223 LIBMEMCACHED_API
 224 memcached_return memcached_flush_buffers(memcached_st *mem);
 225
 226 /* Server Public functions */
 227
 228 LIBMEMCACHED_API
 229 memcached_return memcached_server_add_udp(memcached_st *ptr,
 230                                           const char *hostname,
 231                                           unsigned int port);
 232 LIBMEMCACHED_API
 233 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 234                                                   const char *filename);
 235 LIBMEMCACHED_API
 236 memcached_return memcached_server_add(memcached_st *ptr, const char *hostname,
 237                                       unsigned int port);
 238
 239 LIBMEMCACHED_API
 240 memcached_return memcached_server_add_udp_with_weight(memcached_st *ptr,
 241                                                       const char *hostname,
 242                                                       unsigned int port,
 243                                                       uint32_t weight);
 244 LIBMEMCACHED_API
 245 memcached_return memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 246                                                               const char *filename,
 247                                                               uint32_t weight);
 248 LIBMEMCACHED_API
 249 memcached_return memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 250                                                   unsigned int port,
 251                                                   uint32_t weight);
 252 LIBMEMCACHED_API
 253 void memcached_server_list_free(memcached_server_st *ptr);
 254 LIBMEMCACHED_API
 255 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 256
 257 LIBMEMCACHED_API
 258 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 259                                                   const char *hostname,
 260                                                   unsigned int port,
 261                                                   memcached_return *error);
 262 LIBMEMCACHED_API
 263 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 264                                                               const char *hostname,
 265                                                               unsigned int port,
 266                                                               uint32_t weight,
 267                                                               memcached_return *error);
 268 LIBMEMCACHED_API
 269 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 270 LIBMEMCACHED_API
 271 memcached_server_st *memcached_servers_parse(const char *server_strings);
 272
 273 LIBMEMCACHED_API
 274 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat,
 275                                const char *key, memcached_return *error);
 276 LIBMEMCACHED_API
 277 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat,
 278                                 memcached_return *error);
 279
 280 LIBMEMCACHED_API
 281 memcached_return memcached_delete_by_key(memcached_st *ptr,
 282                                          const char *master_key, size_t master_key_length,
 283                                          const char *key, size_t key_length,
 284                                          time_t expiration);
 285
 286 LIBMEMCACHED_API
 287 memcached_return memcached_fetch_execute(memcached_st *ptr,
 288                                              memcached_execute_function *callback,
 289                                              void *context,
 290                                              unsigned int number_of_callbacks);
 291
 292 LIBMEMCACHED_API
 293 memcached_return memcached_callback_set(memcached_st *ptr,
 294                                         memcached_callback flag,
 295                                         void *data);
 296 LIBMEMCACHED_API
 297 void *memcached_callback_get(memcached_st *ptr,
 298                              memcached_callback flag,
 299                              memcached_return *error);
 300
 301 LIBMEMCACHED_API
 302 memcached_return memcached_dump(memcached_st *ptr, memcached_dump_func *function, void *context, uint32_t number_of_callbacks);
 303
 304
 305 LIBMEMCACHED_API
 306 memcached_return memcached_set_memory_allocators(memcached_st *ptr,
 307                                                  memcached_malloc_function mem_malloc,
 308                                                  memcached_free_function mem_free,
 309                                                  memcached_realloc_function mem_realloc,
 310                                                  memcached_calloc_function mem_calloc);
 311
 312 LIBMEMCACHED_API
 313 void memcached_get_memory_allocators(memcached_st *ptr,
 314                                      memcached_malloc_function *mem_malloc,
 315                                      memcached_free_function *mem_free,
 316                                      memcached_realloc_function *mem_realloc,
 317                                      memcached_calloc_function *mem_calloc);
 318
 319 LIBMEMCACHED_API
 320 void *memcached_get_user_data(memcached_st *ptr);
 321 LIBMEMCACHED_API
 322 void *memcached_set_user_data(memcached_st *ptr, void *data);
 323
 324 LIBMEMCACHED_LOCAL
 325 memcached_return run_distribution(memcached_st *ptr);
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330
 331 #endif /* __MEMCACHED_H__ */