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