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