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 #define LIBMEMCACHED_VERSION_STRING "0.19"
  35
  36 struct memcached_stat_st {
  37   uint32_t pid;
  38   uint32_t uptime;
  39   uint32_t threads;
  40   uint32_t time;
  41   uint32_t pointer_size;
  42   uint32_t rusage_user_seconds;
  43   uint32_t rusage_user_microseconds;
  44   uint32_t rusage_system_seconds;
  45   uint32_t rusage_system_microseconds;
  46   uint32_t curr_items;
  47   uint32_t total_items;
  48   uint64_t limit_maxbytes;
  49   uint32_t curr_connections;
  50   uint32_t total_connections;
  51   uint32_t connection_structures;
  52   uint64_t bytes;
  53   uint64_t cmd_get;
  54   uint64_t cmd_set;
  55   uint64_t get_hits;
  56   uint64_t get_misses;
  57   uint64_t evictions;
  58   uint64_t bytes_read;
  59   uint64_t bytes_written;
  60   char version[MEMCACHED_VERSION_STRING_LENGTH];
  61 };
  62
  63 struct memcached_st {
  64   memcached_allocated is_allocated;
  65   memcached_server_st *hosts;
  66   unsigned int number_of_hosts;
  67   unsigned int cursor_server;
  68   int cached_errno;
  69   uint32_t flags;
  70   int send_size;
  71   int recv_size;
  72   int32_t poll_timeout;
  73   int32_t connect_timeout;
  74   int32_t retry_timeout;
  75   memcached_result_st result;
  76   memcached_hash hash;
  77   memcached_server_distribution distribution;
  78   void *user_data;
  79   unsigned int wheel[MEMCACHED_WHEEL_SIZE];
  80   memcached_clone_func on_clone;
  81   memcached_cleanup_func on_cleanup;
  82   memcached_free_function call_free;
  83   memcached_malloc_function call_malloc;
  84   memcached_realloc_function call_realloc;
  85   memcached_trigger_key get_key_failure;
  86   memcached_trigger_delete_key delete_trigger;
  87 #ifdef NOT_USED /* Future Use */
  88   uint8_t replicas;
  89   memcached_return warning;
  90 #endif
  91 };
  92
  93 /* Public API */
  94 const char * memcached_lib_version(void);
  95
  96 memcached_st *memcached_create(memcached_st *ptr);
  97 void memcached_free(memcached_st *ptr);
  98 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
  99
 100 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 101                                   time_t expiration);
 102 memcached_return memcached_increment(memcached_st *ptr,
 103                                      char *key, size_t key_length,
 104                                      uint32_t offset,
 105                                      uint64_t *value);
 106 memcached_return memcached_decrement(memcached_st *ptr,
 107                                      char *key, size_t key_length,
 108                                      uint32_t offset,
 109                                      uint64_t *value);
 110 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 111 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 112 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 113                                            char *hostname, unsigned int port);
 114 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 115 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 116 void memcached_quit(memcached_st *ptr);
 117 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 118 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
 119 uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 120
 121 /* All of the functions for adding data to the server */
 122 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 123                                char *value, size_t value_length,
 124                                time_t expiration,
 125                                uint32_t  flags);
 126 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 127                                char *value, size_t value_length,
 128                                time_t expiration,
 129                                uint32_t  flags);
 130 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 131                                    char *value, size_t value_length,
 132                                    time_t expiration,
 133                                    uint32_t  flags);
 134 memcached_return memcached_append(memcached_st *ptr,
 135                                   char *key, size_t key_length,
 136                                   char *value, size_t value_length,
 137                                   time_t expiration,
 138                                   uint32_t flags);
 139 memcached_return memcached_prepend(memcached_st *ptr,
 140                                    char *key, size_t key_length,
 141                                    char *value, size_t value_length,
 142                                    time_t expiration,
 143                                    uint32_t flags);
 144 memcached_return memcached_cas(memcached_st *ptr,
 145                                char *key, size_t key_length,
 146                                char *value, size_t value_length,
 147                                time_t expiration,
 148                                uint32_t flags,
 149                                uint64_t cas);
 150
 151 /* Get functions */
 152 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 153                     size_t *value_length,
 154                     uint32_t *flags,
 155                     memcached_return *error);
 156 memcached_return memcached_mget(memcached_st *ptr,
 157                                 char **keys, size_t *key_length,
 158                                 unsigned int number_of_keys);
 159 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 160                       size_t *value_length, uint32_t *flags,
 161                       memcached_return *error);
 162 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 163                                             memcached_result_st *result,
 164                                             memcached_return *error);
 165
 166 /* Server Public functions */
 167
 168 memcached_return memcached_server_add_udp(memcached_st *ptr,
 169                                           char *hostname,
 170                                           unsigned int port);
 171 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 172                                                   char *filename);
 173 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 174                                       unsigned int port);
 175 void memcached_server_list_free(memcached_server_st *ptr);
 176 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 177
 178 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 179                                              char *hostname, unsigned int port,
 180                                              memcached_return *error);
 181 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 182 memcached_server_st *memcached_servers_parse(char *server_strings);
 183
 184 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 185                                char *key, memcached_return *error);
 186 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 187                                 memcached_return *error);
 188
 189 char *memcached_get_by_key(memcached_st *ptr,
 190                            char *master_key, size_t master_key_length,
 191                            char *key, size_t key_length,
 192                            size_t *value_length,
 193                            uint32_t *flags,
 194                            memcached_return *error);
 195
 196 memcached_return memcached_mget_by_key(memcached_st *ptr,
 197                                        char *master_key, size_t master_key_length,
 198                                        char **keys, size_t *key_length,
 199                                        unsigned int number_of_keys);
 200
 201 memcached_return memcached_set_by_key(memcached_st *ptr,
 202                                       char *master_key, size_t master_key_length,
 203                                       char *key, size_t key_length,
 204                                       char *value, size_t value_length,
 205                                       time_t expiration,
 206                                       uint32_t flags);
 207
 208 memcached_return memcached_add_by_key(memcached_st *ptr,
 209                                       char *master_key, size_t master_key_length,
 210                                       char *key, size_t key_length,
 211                                       char *value, size_t value_length,
 212                                       time_t expiration,
 213                                       uint32_t flags);
 214
 215 memcached_return memcached_replace_by_key(memcached_st *ptr,
 216                                           char *master_key, size_t master_key_length,
 217                                           char *key, size_t key_length,
 218                                           char *value, size_t value_length,
 219                                           time_t expiration,
 220                                           uint32_t flags);
 221
 222 memcached_return memcached_prepend_by_key(memcached_st *ptr,
 223                                           char *master_key, size_t master_key_length,
 224                                           char *key, size_t key_length,
 225                                           char *value, size_t value_length,
 226                                           time_t expiration,
 227                                           uint32_t flags);
 228
 229 memcached_return memcached_append_by_key(memcached_st *ptr,
 230                                          char *master_key, size_t master_key_length,
 231                                          char *key, size_t key_length,
 232                                          char *value, size_t value_length,
 233                                          time_t expiration,
 234                                          uint32_t flags);
 235
 236 memcached_return memcached_cas_by_key(memcached_st *ptr,
 237                                       char *master_key, size_t master_key_length,
 238                                       char *key, size_t key_length,
 239                                       char *value, size_t value_length,
 240                                       time_t expiration,
 241                                       uint32_t flags,
 242                                       uint64_t cas);
 243 memcached_return memcached_delete_by_key(memcached_st *ptr,
 244                                          char *master_key, size_t master_key_length,
 245                                          char *key, size_t key_length,
 246                                          time_t expiration);
 247
 248 memcached_return memcached_fetch_execute(memcached_st *ptr,
 249                                              unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
 250                                              void *context,
 251                                              unsigned int number_of_callbacks
 252                                              );
 253
 254 memcached_return memcached_callback_set(memcached_st *ptr,
 255                                         memcached_callback flag,
 256                                         void *data);
 257 void *memcached_callback_get(memcached_st *ptr,
 258                              memcached_callback flag,
 259                              memcached_return *error);
 260
 261 memcached_return memcached_server_cursor(memcached_st *ptr,
 262                                          memcached_server_function *callback,
 263                                          void *context,
 264                                          unsigned int number_of_callbacks);
 265
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271 #endif /* __MEMCACHED_H__ */