git.m6w6.name Git - awesomized/libmemcached/blob - include/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 <stdint.h>
  15 #include <sys/types.h>
  16 #include <netinet/in.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 typedef struct memcached_st memcached_st;
  23 typedef struct memcached_stat_st memcached_stat_st;
  24 typedef struct memcached_result_st memcached_result_st;
  25 typedef struct memcached_string_st memcached_string_st;
  26 typedef struct memcached_server_st memcached_server_st;
  27
  28 #define MEMCACHED_VERSION_STRING 12
  29 #define MEMCACHED_DEFAULT_PORT 11211
  30 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  31 #define SMALL_STRING_LEN 1024
  32 #define HUGE_STRING_LEN 8196
  33 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  34 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
  35 #define MEMCACHED_MAX_HOST_LENGTH 64
  36 #define MEMCACHED_WHEEL_SIZE 1024
  37 #define MEMCACHED_STRIDE 4
  38
  39 typedef enum {
  40   MEMCACHED_SUCCESS,
  41   MEMCACHED_FAILURE,
  42   MEMCACHED_HOST_LOOKUP_FAILURE,
  43   MEMCACHED_CONNECTION_FAILURE,
  44   MEMCACHED_CONNECTION_BIND_FAILURE,
  45   MEMCACHED_WRITE_FAILURE,
  46   MEMCACHED_READ_FAILURE,
  47   MEMCACHED_UNKNOWN_READ_FAILURE,
  48   MEMCACHED_PROTOCOL_ERROR,
  49   MEMCACHED_CLIENT_ERROR,
  50   MEMCACHED_SERVER_ERROR,
  51   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  52   MEMCACHED_DATA_EXISTS,
  53   MEMCACHED_DATA_DOES_NOT_EXIST,
  54   MEMCACHED_NOTSTORED,
  55   MEMCACHED_STORED,
  56   MEMCACHED_NOTFOUND,
  57   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  58   MEMCACHED_PARTIAL_READ,
  59   MEMCACHED_SOME_ERRORS,
  60   MEMCACHED_NO_SERVERS,
  61   MEMCACHED_END,
  62   MEMCACHED_DELETED,
  63   MEMCACHED_VALUE,
  64   MEMCACHED_STAT,
  65   MEMCACHED_ERRNO,
  66   MEMCACHED_FAIL_UNIX_SOCKET,
  67   MEMCACHED_NOT_SUPPORTED,
  68   MEMCACHED_NO_KEY_PROVIDED,
  69   MEMCACHED_FETCH_NOTFINISHED,
  70   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  71 } memcached_return;
  72
  73 typedef enum {
  74   MEMCACHED_DISTRIBUTION_MODULO,
  75   MEMCACHED_DISTRIBUTION_CONSISTENT,
  76 } memcached_server_distribution;
  77
  78 typedef enum {
  79   MEMCACHED_BEHAVIOR_NO_BLOCK,
  80   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  81   MEMCACHED_BEHAVIOR_HASH,
  82   MEMCACHED_BEHAVIOR_KETAMA,
  83   MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
  84   MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
  85   MEMCACHED_BEHAVIOR_CACHE_LOOKUPS,
  86   MEMCACHED_BEHAVIOR_SUPPORT_CAS,
  87   MEMCACHED_BEHAVIOR_POLL_TIMEOUT,
  88   MEMCACHED_BEHAVIOR_DISTRIBUTION,
  89 } memcached_behavior;
  90
  91 typedef enum {
  92   MEMCACHED_HASH_DEFAULT= 0,
  93   MEMCACHED_HASH_MD5,
  94   MEMCACHED_HASH_CRC,
  95   MEMCACHED_HASH_FNV1_64,
  96   MEMCACHED_HASH_FNV1A_64,
  97   MEMCACHED_HASH_FNV1_32,
  98   MEMCACHED_HASH_FNV1A_32,
  99   MEMCACHED_HASH_KETAMA,
 100   MEMCACHED_HASH_HSIEH,
 101 } memcached_hash;
 102
 103 typedef enum {
 104   MEMCACHED_CONNECTION_UNKNOWN,
 105   MEMCACHED_CONNECTION_TCP,
 106   MEMCACHED_CONNECTION_UDP,
 107   MEMCACHED_CONNECTION_UNIX_SOCKET,
 108 } memcached_connection;
 109
 110 typedef enum {
 111   MEMCACHED_NOT_ALLOCATED,
 112   MEMCACHED_ALLOCATED,
 113   MEMCACHED_USED,
 114 } memcached_allocated;
 115
 116 struct memcached_server_st {
 117   char hostname[MEMCACHED_MAX_HOST_LENGTH];
 118   unsigned int port;
 119   int fd;
 120   unsigned int stack_responses;
 121   unsigned int cursor_active;
 122   char write_buffer[MEMCACHED_MAX_BUFFER];
 123   size_t write_buffer_offset;
 124   char *write_ptr;
 125   char read_buffer[MEMCACHED_MAX_BUFFER];
 126   size_t read_buffer_length;
 127   char *read_ptr;
 128   memcached_allocated sockaddr_inited;
 129   struct addrinfo *address_info;
 130   memcached_connection type;
 131   uint8_t major_version;
 132   uint8_t minor_version;
 133   uint8_t micro_version;
 134   uint16_t count;
 135 };
 136
 137 struct memcached_stat_st {
 138   uint32_t pid;
 139   uint32_t uptime;
 140   uint32_t threads;
 141   uint32_t time;
 142   uint32_t pointer_size;
 143   uint32_t rusage_user_seconds;
 144   uint32_t rusage_user_microseconds;
 145   uint32_t rusage_system_seconds;
 146   uint32_t rusage_system_microseconds;
 147   uint32_t curr_items;
 148   uint32_t total_items;
 149   uint32_t limit_maxbytes;
 150   uint32_t curr_connections;
 151   uint32_t total_connections;
 152   uint32_t connection_structures;
 153   uint64_t bytes;
 154   uint64_t cmd_get;
 155   uint64_t cmd_set;
 156   uint64_t get_hits;
 157   uint64_t get_misses;
 158   uint64_t evictions;
 159   uint64_t bytes_read;
 160   uint64_t bytes_written;
 161   char version[MEMCACHED_VERSION_STRING];
 162 };
 163
 164 struct memcached_string_st {
 165   memcached_st *root;
 166   memcached_allocated is_allocated;
 167   char *string;
 168   char *end;
 169   size_t current_size;
 170   size_t block_size;
 171 };
 172
 173 struct memcached_result_st {
 174   memcached_allocated is_allocated;
 175   memcached_st *root;
 176   char key[MEMCACHED_MAX_KEY];
 177   size_t key_length;
 178   memcached_string_st value;
 179   uint16_t flags;
 180   uint64_t cas;
 181 };
 182
 183 struct memcached_st {
 184   memcached_allocated is_allocated;
 185   memcached_server_st *hosts;
 186   unsigned int number_of_hosts;
 187   unsigned int cursor_server;
 188   char connected;
 189   int cached_errno;
 190   unsigned long long flags;
 191   int send_size;
 192   int recv_size;
 193   int32_t poll_timeout;
 194   memcached_string_st result_buffer;
 195   memcached_hash hash;
 196   memcached_server_distribution distribution;
 197   unsigned int wheel[MEMCACHED_WHEEL_SIZE];
 198   uint8_t replicas;
 199   memcached_return warning; /* Future Use */
 200 };
 201
 202 /* Public API */
 203 memcached_st *memcached_create(memcached_st *ptr);
 204 void memcached_free(memcached_st *ptr);
 205 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 206
 207 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 208                                   time_t expiration);
 209 memcached_return memcached_increment(memcached_st *ptr,
 210                                      char *key, size_t key_length,
 211                                      uint32_t offset,
 212                                      uint64_t *value);
 213 memcached_return memcached_decrement(memcached_st *ptr,
 214                                      char *key, size_t key_length,
 215                                      uint32_t offset,
 216                                      uint64_t *value);
 217 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 218 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 219 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 220                                            char *hostname, unsigned int port);
 221 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 222 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 223 void memcached_quit(memcached_st *ptr);
 224 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 225 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 226 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 227
 228 /* All of the functions for adding data to the server */
 229 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 230                                char *value, size_t value_length,
 231                                time_t expiration,
 232                                uint16_t  flags);
 233 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 234                                char *value, size_t value_length,
 235                                time_t expiration,
 236                                uint16_t  flags);
 237 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 238                                    char *value, size_t value_length,
 239                                    time_t expiration,
 240                                    uint16_t  flags);
 241 memcached_return memcached_append(memcached_st *ptr,
 242                                   char *key, size_t key_length,
 243                                   char *value, size_t value_length,
 244                                   time_t expiration,
 245                                   uint16_t flags);
 246 memcached_return memcached_prepend(memcached_st *ptr,
 247                                    char *key, size_t key_length,
 248                                    char *value, size_t value_length,
 249                                    time_t expiration,
 250                                    uint16_t flags);
 251 memcached_return memcached_cas(memcached_st *ptr,
 252                                char *key, size_t key_length,
 253                                char *value, size_t value_length,
 254                                time_t expiration,
 255                                uint16_t flags,
 256                                uint64_t cas);
 257
 258 /* Get functions */
 259 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 260                     size_t *value_length,
 261                     uint16_t *flags,
 262                     memcached_return *error);
 263 memcached_return memcached_mget(memcached_st *ptr,
 264                                 char **keys, size_t *key_length,
 265                                 unsigned int number_of_keys);
 266 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 267                       size_t *value_length, uint16_t *flags,
 268                       memcached_return *error);
 269 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 270                                             memcached_result_st *result,
 271                                             memcached_return *error);
 272
 273 /* Server Public functions */
 274 #define memcached_server_count(A) (A)->number_of_hosts
 275 #define memcached_server_name(A,B) (B).hostname
 276 #define memcached_server_port(A,B) (B).port
 277 #define memcached_server_list(A) (A)->hosts
 278 #define memcached_server_response_count(A,B) (A)->hosts[B].stack_responses
 279
 280 memcached_return memcached_server_add_udp(memcached_st *ptr,
 281                                           char *hostname,
 282                                           unsigned int port);
 283 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 284                                                   char *filename);
 285 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 286                                       unsigned int port);
 287 void memcached_server_list_free(memcached_server_st *ptr);
 288 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 289
 290 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 291                                              char *hostname, unsigned int port,
 292                                              memcached_return *error);
 293 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 294 memcached_server_st *memcached_servers_parse(char *server_strings);
 295
 296 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 297                                char *key, memcached_return *error);
 298 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 299                                 memcached_return *error);
 300
 301 /* Result Struct */
 302 void memcached_result_free(memcached_result_st *result);
 303 memcached_result_st *memcached_result_create(memcached_st *ptr,
 304                                              memcached_result_st *result);
 305 #define memcached_result_key_value(A) A->key
 306 #define memcached_result_key_length(A) A->key_length
 307 #ifdef FIX
 308 #define memcached_result_value(A) memcached_string_value(A->value)
 309 #define memcached_result_length(A) memcached_string_length(A->value)
 310 #else
 311 char *memcached_result_value(memcached_result_st *ptr);
 312 size_t memcached_result_length(memcached_result_st *ptr);
 313 #endif
 314 #define memcached_result_flags(A) A->flags
 315 #define memcached_result_cas(A) A->cas
 316
 317
 318 #ifndef __WATCHPOINT_H__
 319 #define __WATCHPOINT_H__
 320 /* Some personal debugging functions */
 321 #ifdef HAVE_DEBUG
 322 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 323 #ifdef __MEMCACHED_H__
 324 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 325 #endif
 326 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
 327 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
 328 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
 329 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
 330 #define WATCHPOINT_ASSERT(A) assert((A));
 331 #else
 332 /*
 333 #define WATCHPOINT { 1; };
 334 #define WATCHPOINT_ERROR(A) { 1; };
 335 #define WATCHPOINT_STRING(A) { 1; };
 336 #define WATCHPOINT_STRING_LENGTH(A,B) { 1; };
 337 #define WATCHPOINT_NUMBER(A) { 1; };
 338 #define WATCHPOINT_ERRNO(A) { 1; };
 339 #define WATCHPOINT_ASSERT(A) { 1; };
 340 */
 341 #define WATCHPOINT
 342 #ifdef __MEMCACHED_H__
 343 #define WATCHPOINT_ERROR(A)
 344 #endif
 345 #define WATCHPOINT_STRING(A)
 346 #define WATCHPOINT_NUMBER(A)
 347 #define WATCHPOINT_ERRNO(A)
 348 #define WATCHPOINT_ASSERT(A)
 349 #endif
 350
 351 #endif /* __WATCHPOINT_H__ */
 352
 353
 354 #ifdef __cplusplus
 355 }
 356 #endif
 357
 358 #endif /* __MEMCACHED_H__ */