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