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