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 #include <sys/types.h>
  16 #include <netinet/in.h>
  17
  18 #ifdef MEMCACHED_INTERNAL
  19 #include <libmemcached/libmemcached_config.h>
  20 #endif
  21 #include <libmemcached/memcached_constants.h>
  22 #include <libmemcached/memcached_types.h>
  23 #include <libmemcached/memcached_watchpoint.h>
  24 #include <libmemcached/memcached_get.h>
  25 #include <libmemcached/memcached_server.h>
  26 #include <libmemcached/memcached_string.h>
  27 #include <libmemcached/memcached_result.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* These are Private and should not be used by applications */
  34 #define MEMCACHED_VERSION_STRING_LENGTH 12
  35
  36 /* string value */
  37 struct memcached_continuum_item_st {
  38   uint32_t index;
  39   uint32_t value;
  40 };
  41
  42 #define LIBMEMCACHED_VERSION_STRING "0.24"
  43
  44 struct memcached_stat_st {
  45   uint32_t pid;
  46   uint32_t uptime;
  47   uint32_t threads;
  48   uint32_t time;
  49   uint32_t pointer_size;
  50   uint32_t rusage_user_seconds;
  51   uint32_t rusage_user_microseconds;
  52   uint32_t rusage_system_seconds;
  53   uint32_t rusage_system_microseconds;
  54   uint32_t curr_items;
  55   uint32_t total_items;
  56   uint64_t limit_maxbytes;
  57   uint32_t curr_connections;
  58   uint32_t total_connections;
  59   uint32_t connection_structures;
  60   uint64_t bytes;
  61   uint64_t cmd_get;
  62   uint64_t cmd_set;
  63   uint64_t get_hits;
  64   uint64_t get_misses;
  65   uint64_t evictions;
  66   uint64_t bytes_read;
  67   uint64_t bytes_written;
  68   char version[MEMCACHED_VERSION_STRING_LENGTH];
  69 };
  70
  71 struct memcached_st {
  72   memcached_allocated is_allocated;
  73   memcached_server_st *hosts;
  74   uint32_t number_of_hosts;
  75   uint32_t cursor_server;
  76   int cached_errno;
  77   uint32_t flags;
  78   int send_size;
  79   int recv_size;
  80   int32_t poll_timeout;
  81   int32_t connect_timeout;
  82   int32_t retry_timeout;
  83   memcached_result_st result;
  84   memcached_hash hash;
  85   memcached_server_distribution distribution;
  86   void *user_data;
  87   uint32_t continuum_count;
  88   memcached_continuum_item_st *continuum;
  89   memcached_clone_func on_clone;
  90   memcached_cleanup_func on_cleanup;
  91   memcached_free_function call_free;
  92   memcached_malloc_function call_malloc;
  93   memcached_realloc_function call_realloc;
  94   memcached_trigger_key get_key_failure;
  95   memcached_trigger_delete_key delete_trigger;
  96   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
  97   size_t prefix_key_length;
  98   memcached_hash hash_continuum;
  99   uint32_t continuum_points_counter;
 100   int32_t snd_timeout;
 101   int32_t rcv_timeout;
 102   uint32_t server_failure_limit;
 103 };
 104
 105
 106 /* Public API */
 107 const char * memcached_lib_version(void);
 108
 109 memcached_st *memcached_create(memcached_st *ptr);
 110 void memcached_free(memcached_st *ptr);
 111 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 112
 113 memcached_return memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
 114                                   time_t expiration);
 115 memcached_return memcached_increment(memcached_st *ptr,
 116                                      const char *key, size_t key_length,
 117                                      uint32_t offset,
 118                                      uint64_t *value);
 119 memcached_return memcached_decrement(memcached_st *ptr,
 120                                      const char *key, size_t key_length,
 121                                      uint32_t offset,
 122                                      uint64_t *value);
 123 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 124 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 125 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 126                                            char *hostname, unsigned int port);
 127 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 128 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 129 void memcached_quit(memcached_st *ptr);
 130 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 131 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
 132 uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 133
 134 /* Server Public functions */
 135
 136 memcached_return memcached_server_add_udp(memcached_st *ptr,
 137                                           const char *hostname,
 138                                           unsigned int port);
 139 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 140                                                   const char *filename);
 141 memcached_return memcached_server_add(memcached_st *ptr, const char *hostname,
 142                                       unsigned int port);
 143 void memcached_server_list_free(memcached_server_st *ptr);
 144 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 145
 146 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 147                                              const char *hostname, unsigned int port,
 148                                              memcached_return *error);
 149 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 150 memcached_server_st *memcached_servers_parse(char *server_strings);
 151
 152 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 153                                char *key, memcached_return *error);
 154 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 155                                 memcached_return *error);
 156
 157 memcached_return memcached_delete_by_key(memcached_st *ptr,
 158                                          const char *master_key, size_t master_key_length,
 159                                          const char *key, size_t key_length,
 160                                          time_t expiration);
 161
 162 memcached_return memcached_fetch_execute(memcached_st *ptr,
 163                                              memcached_execute_function *callback,
 164                                              void *context,
 165                                              unsigned int number_of_callbacks);
 166
 167 memcached_return memcached_callback_set(memcached_st *ptr,
 168                                         memcached_callback flag,
 169                                         void *data);
 170 void *memcached_callback_get(memcached_st *ptr,
 171                              memcached_callback flag,
 172                              memcached_return *error);
 173
 174
 175 #ifdef __cplusplus
 176 }
 177 #endif
 178
 179 #include <libmemcached/memcached_storage.h>
 180
 181 #endif /* __MEMCACHED_H__ */