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   struct {
  77     bool is_allocated:1;
  78     bool is_initialized:1;
  79     bool is_purging:1;
  80   } options;
  81   uint8_t distribution;
  82   uint8_t hash;
  83   uint32_t continuum_points_counter;
  84   memcached_server_st *hosts;
  85   memcached_server_st *last_disconnected_server;
  86   int32_t snd_timeout;
  87   int32_t rcv_timeout;
  88   uint32_t server_failure_limit;
  89   uint32_t io_msg_watermark;
  90   uint32_t io_bytes_watermark;
  91   uint32_t io_key_prefetch;
  92   uint32_t number_of_hosts;
  93   uint32_t cursor_server;
  94   int cached_errno;
  95   uint32_t flags;
  96   int32_t poll_timeout;
  97   int32_t connect_timeout;
  98   int32_t retry_timeout;
  99   uint32_t continuum_count;
 100   int send_size;
 101   int recv_size;
 102   void *user_data;
 103   time_t next_distribution_rebuild;
 104   size_t prefix_key_length;
 105   memcached_hash hash_continuum;
 106   memcached_result_st result;
 107   memcached_continuum_item_st *continuum;
 108   memcached_clone_func on_clone;
 109   memcached_cleanup_func on_cleanup;
 110   memcached_free_function call_free;
 111   memcached_malloc_function call_malloc;
 112   memcached_realloc_function call_realloc;
 113   memcached_calloc_function call_calloc;
 114   memcached_trigger_key get_key_failure;
 115   memcached_trigger_delete_key delete_trigger;
 116   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
 117   uint32_t number_of_replicas;
 118   memcached_callback_st *callbacks;
 119 };
 120
 121 LIBMEMCACHED_API
 122 memcached_return memcached_version(memcached_st *ptr);
 123
 124 /* Public API */
 125
 126 LIBMEMCACHED_API
 127 const char * memcached_lib_version(void);
 128
 129 LIBMEMCACHED_API
 130 memcached_st *memcached_create(memcached_st *ptr);
 131 LIBMEMCACHED_API
 132 void memcached_free(memcached_st *ptr);
 133 LIBMEMCACHED_API
 134 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 135
 136 LIBMEMCACHED_API
 137 memcached_return memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
 138                                   time_t expiration);
 139 LIBMEMCACHED_API
 140 memcached_return memcached_increment(memcached_st *ptr,
 141                                      const char *key, size_t key_length,
 142                                      uint32_t offset,
 143                                      uint64_t *value);
 144 LIBMEMCACHED_API
 145 memcached_return memcached_decrement(memcached_st *ptr,
 146                                      const char *key, size_t key_length,
 147                                      uint32_t offset,
 148                                      uint64_t *value);
 149
 150 LIBMEMCACHED_API
 151 memcached_return memcached_increment_by_key(memcached_st *ptr,
 152                                             const char *master_key, size_t master_key_length,
 153                                             const char *key, size_t key_length,
 154                                             uint64_t offset,
 155                                             uint64_t *value);
 156
 157 LIBMEMCACHED_API
 158 memcached_return memcached_decrement_by_key(memcached_st *ptr,
 159                                             const char *master_key, size_t master_key_length,
 160                                             const char *key, size_t key_length,
 161                                             uint64_t offset,
 162                                             uint64_t *value);
 163
 164 LIBMEMCACHED_API
 165 memcached_return memcached_increment_with_initial(memcached_st *ptr,
 166                                                   const char *key,
 167                                                   size_t key_length,
 168                                                   uint64_t offset,
 169                                                   uint64_t initial,
 170                                                   time_t expiration,
 171                                                   uint64_t *value);
 172 LIBMEMCACHED_API
 173 memcached_return memcached_decrement_with_initial(memcached_st *ptr,
 174                                                   const char *key,
 175                                                   size_t key_length,
 176                                                   uint64_t offset,
 177                                                   uint64_t initial,
 178                                                   time_t expiration,
 179                                                   uint64_t *value);
 180 LIBMEMCACHED_API
 181 memcached_return memcached_increment_with_initial_by_key(memcached_st *ptr,
 182                                                          const char *master_key,
 183                                                          size_t master_key_length,
 184                                                          const char *key,
 185                                                          size_t key_length,
 186                                                          uint64_t offset,
 187                                                          uint64_t initial,
 188                                                          time_t expiration,
 189                                                          uint64_t *value);
 190 LIBMEMCACHED_API
 191 memcached_return memcached_decrement_with_initial_by_key(memcached_st *ptr,
 192                                                          const char *master_key,
 193                                                          size_t master_key_length,
 194                                                          const char *key,
 195                                                          size_t key_length,
 196                                                          uint64_t offset,
 197                                                          uint64_t initial,
 198                                                          time_t expiration,
 199                                                          uint64_t *value);
 200 LIBMEMCACHED_API
 201 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 202 LIBMEMCACHED_API
 203 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 204 LIBMEMCACHED_API
 205 memcached_return memcached_stat_servername(memcached_stat_st *memc_stat, char *args,
 206                                            char *hostname, unsigned int port);
 207 LIBMEMCACHED_API
 208 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 209 LIBMEMCACHED_API
 210 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 211 LIBMEMCACHED_API
 212 void memcached_quit(memcached_st *ptr);
 213 LIBMEMCACHED_API
 214 const char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 215 LIBMEMCACHED_API
 216 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
 217 LIBMEMCACHED_API
 218 uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 219
 220 /* The two public hash bits */
 221 LIBMEMCACHED_API
 222 uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash hash_algorithm);
 223 LIBMEMCACHED_API
 224 uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
 225
 226 LIBMEMCACHED_API
 227 memcached_return memcached_flush_buffers(memcached_st *mem);
 228
 229 /* Server Public functions */
 230
 231 LIBMEMCACHED_API
 232 memcached_return memcached_server_add_udp(memcached_st *ptr,
 233                                           const char *hostname,
 234                                           unsigned int port);
 235 LIBMEMCACHED_API
 236 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 237                                                   const char *filename);
 238 LIBMEMCACHED_API
 239 memcached_return memcached_server_add(memcached_st *ptr, const char *hostname,
 240                                       unsigned int port);
 241
 242 LIBMEMCACHED_API
 243 memcached_return memcached_server_add_udp_with_weight(memcached_st *ptr,
 244                                                       const char *hostname,
 245                                                       unsigned int port,
 246                                                       uint32_t weight);
 247 LIBMEMCACHED_API
 248 memcached_return memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 249                                                               const char *filename,
 250                                                               uint32_t weight);
 251 LIBMEMCACHED_API
 252 memcached_return memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 253                                                   unsigned int port,
 254                                                   uint32_t weight);
 255 LIBMEMCACHED_API
 256 void memcached_server_list_free(memcached_server_st *ptr);
 257 LIBMEMCACHED_API
 258 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 259
 260 LIBMEMCACHED_API
 261 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 262                                                   const char *hostname,
 263                                                   unsigned int port,
 264                                                   memcached_return *error);
 265 LIBMEMCACHED_API
 266 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 267                                                               const char *hostname,
 268                                                               unsigned int port,
 269                                                               uint32_t weight,
 270                                                               memcached_return *error);
 271 LIBMEMCACHED_API
 272 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 273 LIBMEMCACHED_API
 274 memcached_server_st *memcached_servers_parse(const char *server_strings);
 275
 276 LIBMEMCACHED_API
 277 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat,
 278                                const char *key, memcached_return *error);
 279 LIBMEMCACHED_API
 280 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat,
 281                                 memcached_return *error);
 282
 283 LIBMEMCACHED_API
 284 memcached_return memcached_delete_by_key(memcached_st *ptr,
 285                                          const char *master_key, size_t master_key_length,
 286                                          const char *key, size_t key_length,
 287                                          time_t expiration);
 288
 289 LIBMEMCACHED_API
 290 memcached_return memcached_fetch_execute(memcached_st *ptr,
 291                                              memcached_execute_function *callback,
 292                                              void *context,
 293                                              unsigned int number_of_callbacks);
 294
 295 LIBMEMCACHED_API
 296 memcached_return memcached_callback_set(memcached_st *ptr,
 297                                         memcached_callback flag,
 298                                         void *data);
 299 LIBMEMCACHED_API
 300 void *memcached_callback_get(memcached_st *ptr,
 301                              memcached_callback flag,
 302                              memcached_return *error);
 303
 304 LIBMEMCACHED_API
 305 memcached_return memcached_dump(memcached_st *ptr, memcached_dump_func *function, void *context, uint32_t number_of_callbacks);
 306
 307
 308 LIBMEMCACHED_API
 309 memcached_return memcached_set_memory_allocators(memcached_st *ptr,
 310                                                  memcached_malloc_function mem_malloc,
 311                                                  memcached_free_function mem_free,
 312                                                  memcached_realloc_function mem_realloc,
 313                                                  memcached_calloc_function mem_calloc);
 314
 315 LIBMEMCACHED_API
 316 void memcached_get_memory_allocators(memcached_st *ptr,
 317                                      memcached_malloc_function *mem_malloc,
 318                                      memcached_free_function *mem_free,
 319                                      memcached_realloc_function *mem_realloc,
 320                                      memcached_calloc_function *mem_calloc);
 321
 322 LIBMEMCACHED_API
 323 void *memcached_get_user_data(memcached_st *ptr);
 324 LIBMEMCACHED_API
 325 void *memcached_set_user_data(memcached_st *ptr, void *data);
 326
 327 LIBMEMCACHED_LOCAL
 328 memcached_return run_distribution(memcached_st *ptr);
 329
 330 #define memcached_is_allocated(__object) ((__object)->options.is_allocated)
 331 #define memcached_is_initialized(__object) ((__object)->options.is_initialized)
 332
 333 #ifdef __cplusplus
 334 }
 335 #endif
 336
 337
 338 #endif /* __MEMCACHED_H__ */