git.m6w6.name Git - m6w6/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 #ifdef MEMCACHED_INTERNAL
  22 #include <libmemcached/libmemcached_config.h>
  23 #endif
  24 #include <libmemcached/memcached_configure.h>
  25 #include <libmemcached/memcached_constants.h>
  26 #include <libmemcached/memcached_types.h>
  27 #include <libmemcached/memcached_watchpoint.h>
  28 #include <libmemcached/memcached_get.h>
  29 #include <libmemcached/memcached_server.h>
  30 #include <libmemcached/memcached_string.h>
  31 #include <libmemcached/memcached_result.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* These are Private and should not be used by applications */
  38 #define MEMCACHED_VERSION_STRING_LENGTH 24
  39
  40 /* string value */
  41 struct memcached_continuum_item_st {
  42   uint32_t index;
  43   uint32_t value;
  44 };
  45
  46 #define LIBMEMCACHED_VERSION_STRING "0.30"
  47
  48 struct memcached_analysis_st {
  49   uint32_t average_item_size;
  50   uint32_t longest_uptime;
  51   uint32_t least_free_server;
  52   uint32_t most_consumed_server;
  53   uint32_t oldest_server;
  54   double pool_hit_ratio;
  55   uint64_t most_used_bytes;
  56   uint64_t least_remaining_bytes;
  57 };
  58
  59 struct memcached_stat_st {
  60   uint32_t connection_structures;
  61   uint32_t curr_connections;
  62   uint32_t curr_items;
  63   uint32_t pid;
  64   uint32_t pointer_size;
  65   uint32_t rusage_system_microseconds;
  66   uint32_t rusage_system_seconds;
  67   uint32_t rusage_user_microseconds;
  68   uint32_t rusage_user_seconds;
  69   uint32_t threads;
  70   uint32_t time;
  71   uint32_t total_connections;
  72   uint32_t total_items;
  73   uint32_t uptime;
  74   uint64_t bytes;
  75   uint64_t bytes_read;
  76   uint64_t bytes_written;
  77   uint64_t cmd_get;
  78   uint64_t cmd_set;
  79   uint64_t evictions;
  80   uint64_t get_hits;
  81   uint64_t get_misses;
  82   uint64_t limit_maxbytes;
  83   char version[MEMCACHED_VERSION_STRING_LENGTH];
  84 };
  85
  86 struct memcached_st {
  87   uint8_t purging;
  88   bool is_allocated;
  89   uint8_t distribution;
  90   uint8_t hash;
  91   uint32_t continuum_points_counter;
  92   memcached_server_st *hosts;
  93   int32_t snd_timeout;
  94   int32_t rcv_timeout;
  95   uint32_t server_failure_limit;
  96   uint32_t io_msg_watermark;
  97   uint32_t io_bytes_watermark;
  98   uint32_t io_key_prefetch;
  99   uint32_t number_of_hosts;
 100   uint32_t cursor_server;
 101   int cached_errno;
 102   uint32_t flags;
 103   int32_t poll_timeout;
 104   int32_t connect_timeout;
 105   int32_t retry_timeout;
 106   uint32_t continuum_count;
 107   int send_size;
 108   int recv_size;
 109   void *user_data;
 110   time_t next_distribution_rebuild;
 111   size_t prefix_key_length;
 112   memcached_hash hash_continuum;
 113   memcached_result_st result;
 114   memcached_continuum_item_st *continuum;
 115   memcached_clone_func on_clone;
 116   memcached_cleanup_func on_cleanup;
 117   memcached_free_function call_free;
 118   memcached_malloc_function call_malloc;
 119   memcached_realloc_function call_realloc;
 120   memcached_calloc_function call_calloc;
 121   memcached_trigger_key get_key_failure;
 122   memcached_trigger_delete_key delete_trigger;
 123   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
 124   uint32_t number_of_replicas;
 125 };
 126
 127
 128 /* Public API */
 129 const char * memcached_lib_version(void);
 130
 131 memcached_st *memcached_create(memcached_st *ptr);
 132 void memcached_free(memcached_st *ptr);
 133 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 134
 135 memcached_return memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
 136                                   time_t expiration);
 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 memcached_return memcached_decrement(memcached_st *ptr,
 142                                      const char *key, size_t key_length,
 143                                      uint32_t offset,
 144                                      uint64_t *value);
 145 memcached_return memcached_increment_with_initial(memcached_st *ptr,
 146                                                   const char *key,
 147                                                   size_t key_length,
 148                                                   uint64_t offset,
 149                                                   uint64_t initial,
 150                                                   time_t expiration,
 151                                                   uint64_t *value);
 152 memcached_return memcached_decrement_with_initial(memcached_st *ptr,
 153                                                   const char *key,
 154                                                   size_t key_length,
 155                                                   uint64_t offset,
 156                                                   uint64_t initial,
 157                                                   time_t expiration,
 158                                                   uint64_t *value);
 159 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 160 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 161 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 162                                            char *hostname, unsigned int port);
 163 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 164 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 165 void memcached_quit(memcached_st *ptr);
 166 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 167 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
 168 uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 169
 170 /* The two public hash bits */
 171 uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash hash_algorithm);
 172 uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
 173
 174 memcached_return memcached_flush_buffers(memcached_st *mem);
 175
 176 /* Server Public functions */
 177
 178 memcached_return memcached_server_add_udp(memcached_st *ptr,
 179                                           const char *hostname,
 180                                           unsigned int port);
 181 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 182                                                   const char *filename);
 183 memcached_return memcached_server_add(memcached_st *ptr, const char *hostname,
 184                                       unsigned int port);
 185
 186 memcached_return memcached_server_add_udp_with_weight(memcached_st *ptr,
 187                                                       const char *hostname,
 188                                                       unsigned int port,
 189                                                       uint32_t weight);
 190 memcached_return memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 191                                                               const char *filename,
 192                                                               uint32_t weight);
 193 memcached_return memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 194                                                   unsigned int port,
 195                                                   uint32_t weight);
 196 void memcached_server_list_free(memcached_server_st *ptr);
 197 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 198
 199 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 200                                                   const char *hostname,
 201                                                   unsigned int port,
 202                                                   memcached_return *error);
 203 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 204                                                               const char *hostname,
 205                                                               unsigned int port,
 206                                                               uint32_t weight,
 207                                                               memcached_return *error);
 208 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 209 memcached_server_st *memcached_servers_parse(const char *server_strings);
 210
 211 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 212                                const char *key, memcached_return *error);
 213 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 214                                 memcached_return *error);
 215
 216 memcached_return memcached_delete_by_key(memcached_st *ptr,
 217                                          const char *master_key, size_t master_key_length,
 218                                          const char *key, size_t key_length,
 219                                          time_t expiration);
 220
 221 memcached_return memcached_fetch_execute(memcached_st *ptr,
 222                                              memcached_execute_function *callback,
 223                                              void *context,
 224                                              unsigned int number_of_callbacks);
 225
 226 memcached_return memcached_callback_set(memcached_st *ptr,
 227                                         memcached_callback flag,
 228                                         void *data);
 229 void *memcached_callback_get(memcached_st *ptr,
 230                              memcached_callback flag,
 231                              memcached_return *error);
 232
 233 memcached_return memcached_dump(memcached_st *ptr, memcached_dump_func *function, void *context, uint32_t number_of_callbacks);
 234
 235
 236 memcached_return memcached_set_memory_allocators(memcached_st *ptr,
 237                                                  memcached_malloc_function mem_malloc,
 238                                                  memcached_free_function mem_free,
 239                                                  memcached_realloc_function mem_realloc,
 240                                                  memcached_calloc_function mem_calloc);
 241
 242 void memcached_get_memory_allocators(memcached_st *ptr,
 243                                      memcached_malloc_function *mem_malloc,
 244                                      memcached_free_function *mem_free,
 245                                      memcached_realloc_function *mem_realloc,
 246                                      memcached_calloc_function *mem_calloc);
 247
 248 void *memcached_get_user_data(memcached_st *ptr);
 249 void *memcached_set_user_data(memcached_st *ptr, void *data);
 250
 251 #ifdef __cplusplus
 252 }
 253 #endif
 254
 255 #include <libmemcached/memcached_storage.h>
 256
 257 #ifdef MEMCACHED_INTERNAL
 258 #include <libmemcached/memcached_internal.h>
 259 #endif
 260
 261 #endif /* __MEMCACHED_H__ */