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