git.m6w6.name Git - m6w6/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.17"
  36
  37 typedef enum {
  38   MEMCACHED_SUCCESS,
  39   MEMCACHED_FAILURE,
  40   MEMCACHED_HOST_LOOKUP_FAILURE,
  41   MEMCACHED_CONNECTION_FAILURE,
  42   MEMCACHED_CONNECTION_BIND_FAILURE,
  43   MEMCACHED_WRITE_FAILURE,
  44   MEMCACHED_READ_FAILURE,
  45   MEMCACHED_UNKNOWN_READ_FAILURE,
  46   MEMCACHED_PROTOCOL_ERROR,
  47   MEMCACHED_CLIENT_ERROR,
  48   MEMCACHED_SERVER_ERROR,
  49   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  50   MEMCACHED_DATA_EXISTS,
  51   MEMCACHED_DATA_DOES_NOT_EXIST,
  52   MEMCACHED_NOTSTORED,
  53   MEMCACHED_STORED,
  54   MEMCACHED_NOTFOUND,
  55   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  56   MEMCACHED_PARTIAL_READ,
  57   MEMCACHED_SOME_ERRORS,
  58   MEMCACHED_NO_SERVERS,
  59   MEMCACHED_END,
  60   MEMCACHED_DELETED,
  61   MEMCACHED_VALUE,
  62   MEMCACHED_STAT,
  63   MEMCACHED_ERRNO,
  64   MEMCACHED_FAIL_UNIX_SOCKET,
  65   MEMCACHED_NOT_SUPPORTED,
  66   MEMCACHED_NO_KEY_PROVIDED,
  67   MEMCACHED_FETCH_NOTFINISHED,
  68   MEMCACHED_TIMEOUT,
  69   MEMCACHED_BUFFERED,
  70   MEMCACHED_BAD_KEY_PROVIDED,
  71   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  72 } memcached_return;
  73
  74 typedef struct memcached_st memcached_st;
  75 typedef struct memcached_stat_st memcached_stat_st;
  76 typedef struct memcached_result_st memcached_result_st;
  77 typedef struct memcached_string_st memcached_string_st;
  78 typedef struct memcached_server_st memcached_server_st;
  79 typedef memcached_return (*memcached_clone_func)(memcached_st *parent, memcached_st *clone);
  80 typedef memcached_return (*memcached_cleanup_func)(memcached_st *ptr);
  81 typedef void (*memcached_free_function)(memcached_st *ptr, void *mem);
  82 typedef void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size);
  83 typedef void *(*memcached_realloc_function)(memcached_st *ptr, void *mem, const size_t size);
  84 typedef unsigned int (*memcached_execute_function)(memcached_st *ptr, memcached_result_st *result, void *context);
  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_SORT_HOSTS,
 105   MEMCACHED_BEHAVIOR_VERIFY_KEY,
 106   MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT,
 107 } memcached_behavior;
 108
 109 typedef enum {
 110   MEMCACHED_CALLBACK_USER_DATA,
 111   MEMCACHED_CALLBACK_CLEANUP_FUNCTION,
 112   MEMCACHED_CALLBACK_CLONE_FUNCTION,
 113   MEMCACHED_CALLBACK_MALLOC_FUNCTION,
 114   MEMCACHED_CALLBACK_REALLOC_FUNCTION,
 115   MEMCACHED_CALLBACK_FREE_FUNCTION,
 116 } memcached_callback;
 117
 118 typedef enum {
 119   MEMCACHED_HASH_DEFAULT= 0,
 120   MEMCACHED_HASH_MD5,
 121   MEMCACHED_HASH_CRC,
 122   MEMCACHED_HASH_FNV1_64,
 123   MEMCACHED_HASH_FNV1A_64,
 124   MEMCACHED_HASH_FNV1_32,
 125   MEMCACHED_HASH_FNV1A_32,
 126   MEMCACHED_HASH_KETAMA,
 127   MEMCACHED_HASH_HSIEH,
 128 } memcached_hash;
 129
 130 typedef enum {
 131   MEMCACHED_CONNECTION_UNKNOWN,
 132   MEMCACHED_CONNECTION_TCP,
 133   MEMCACHED_CONNECTION_UDP,
 134   MEMCACHED_CONNECTION_UNIX_SOCKET,
 135 } memcached_connection;
 136
 137 typedef enum {
 138   MEMCACHED_NOT_ALLOCATED,
 139   MEMCACHED_ALLOCATED,
 140   MEMCACHED_USED,
 141 } memcached_allocated;
 142
 143 struct memcached_server_st {
 144   char hostname[MEMCACHED_MAX_HOST_LENGTH];
 145   unsigned int port;
 146   int fd;
 147   int cached_errno;
 148   unsigned int cursor_active;
 149   char write_buffer[MEMCACHED_MAX_BUFFER];
 150   size_t write_buffer_offset;
 151   char read_buffer[MEMCACHED_MAX_BUFFER];
 152   size_t read_data_length;
 153   size_t read_buffer_length;
 154   char *read_ptr;
 155   memcached_allocated sockaddr_inited;
 156   struct addrinfo *address_info;
 157   memcached_connection type;
 158   uint8_t major_version;
 159   uint8_t minor_version;
 160   uint8_t micro_version;
 161   uint16_t count;
 162   memcached_st *root;
 163 };
 164
 165 struct memcached_stat_st {
 166   uint32_t pid;
 167   uint32_t uptime;
 168   uint32_t threads;
 169   uint32_t time;
 170   uint32_t pointer_size;
 171   uint32_t rusage_user_seconds;
 172   uint32_t rusage_user_microseconds;
 173   uint32_t rusage_system_seconds;
 174   uint32_t rusage_system_microseconds;
 175   uint32_t curr_items;
 176   uint32_t total_items;
 177   uint64_t limit_maxbytes;
 178   uint32_t curr_connections;
 179   uint32_t total_connections;
 180   uint32_t connection_structures;
 181   uint64_t bytes;
 182   uint64_t cmd_get;
 183   uint64_t cmd_set;
 184   uint64_t get_hits;
 185   uint64_t get_misses;
 186   uint64_t evictions;
 187   uint64_t bytes_read;
 188   uint64_t bytes_written;
 189   char version[MEMCACHED_VERSION_STRING_LENGTH];
 190 };
 191
 192 struct memcached_string_st {
 193   memcached_st *root;
 194   memcached_allocated is_allocated;
 195   char *string;
 196   char *end;
 197   size_t current_size;
 198   size_t block_size;
 199 };
 200
 201 struct memcached_result_st {
 202   memcached_allocated is_allocated;
 203   memcached_st *root;
 204   char key[MEMCACHED_MAX_KEY];
 205   size_t key_length;
 206   memcached_string_st value;
 207   uint32_t flags;
 208   uint64_t cas;
 209   /* Add result callback function */
 210 };
 211
 212 struct memcached_st {
 213   memcached_allocated is_allocated;
 214   memcached_server_st *hosts;
 215   unsigned int number_of_hosts;
 216   unsigned int cursor_server;
 217   int cached_errno;
 218   uint32_t flags;
 219   int send_size;
 220   int recv_size;
 221   int32_t poll_timeout;
 222   int32_t connect_timeout;
 223   memcached_result_st result;
 224   memcached_hash hash;
 225   memcached_server_distribution distribution;
 226   void *user_data;
 227   unsigned int wheel[MEMCACHED_WHEEL_SIZE];
 228   memcached_clone_func on_clone;
 229   memcached_cleanup_func on_cleanup;
 230   memcached_free_function call_free;
 231   memcached_malloc_function call_malloc;
 232   memcached_realloc_function call_realloc;
 233 #ifdef NOT_USED /* Future Use */
 234   uint8_t replicas;
 235   memcached_return warning;
 236 #endif
 237 };
 238
 239 /* Public API */
 240 const char * memcached_lib_version(void);
 241
 242 memcached_st *memcached_create(memcached_st *ptr);
 243 void memcached_free(memcached_st *ptr);
 244 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 245
 246 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 247                                   time_t expiration);
 248 memcached_return memcached_increment(memcached_st *ptr,
 249                                      char *key, size_t key_length,
 250                                      uint32_t offset,
 251                                      uint64_t *value);
 252 memcached_return memcached_decrement(memcached_st *ptr,
 253                                      char *key, size_t key_length,
 254                                      uint32_t offset,
 255                                      uint64_t *value);
 256 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 257 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 258 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 259                                            char *hostname, unsigned int port);
 260 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 261 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 262 void memcached_quit(memcached_st *ptr);
 263 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 264 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 265 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 266
 267 /* All of the functions for adding data to the server */
 268 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 269                                char *value, size_t value_length,
 270                                time_t expiration,
 271                                uint32_t  flags);
 272 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 273                                char *value, size_t value_length,
 274                                time_t expiration,
 275                                uint32_t  flags);
 276 memcached_return memcached_replace(memcached_st *ptr, 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_append(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 memcached_return memcached_prepend(memcached_st *ptr,
 286                                    char *key, size_t key_length,
 287                                    char *value, size_t value_length,
 288                                    time_t expiration,
 289                                    uint32_t flags);
 290 memcached_return memcached_cas(memcached_st *ptr,
 291                                char *key, size_t key_length,
 292                                char *value, size_t value_length,
 293                                time_t expiration,
 294                                uint32_t flags,
 295                                uint64_t cas);
 296
 297 /* Get functions */
 298 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 299                     size_t *value_length,
 300                     uint32_t *flags,
 301                     memcached_return *error);
 302 memcached_return memcached_mget(memcached_st *ptr,
 303                                 char **keys, size_t *key_length,
 304                                 unsigned int number_of_keys);
 305 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 306                       size_t *value_length, uint32_t *flags,
 307                       memcached_return *error);
 308 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 309                                             memcached_result_st *result,
 310                                             memcached_return *error);
 311
 312 /* Server Public functions */
 313 #define memcached_server_count(A) (A)->number_of_hosts
 314 #define memcached_server_name(A,B) (B).hostname
 315 #define memcached_server_port(A,B) (B).port
 316 #define memcached_server_list(A) (A)->hosts
 317 #define memcached_server_response_count(A) (A)->cursor_active
 318
 319
 320 memcached_return memcached_server_add_udp(memcached_st *ptr,
 321                                           char *hostname,
 322                                           unsigned int port);
 323 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 324                                                   char *filename);
 325 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 326                                       unsigned int port);
 327 void memcached_server_list_free(memcached_server_st *ptr);
 328 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 329
 330 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 331                                              char *hostname, unsigned int port,
 332                                              memcached_return *error);
 333 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 334 memcached_server_st *memcached_servers_parse(char *server_strings);
 335
 336 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 337                                char *key, memcached_return *error);
 338 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 339                                 memcached_return *error);
 340
 341 char *memcached_get_by_key(memcached_st *ptr,
 342                            char *master_key, size_t master_key_length,
 343                            char *key, size_t key_length,
 344                            size_t *value_length,
 345                            uint32_t *flags,
 346                            memcached_return *error);
 347
 348 memcached_return memcached_mget_by_key(memcached_st *ptr,
 349                                        char *master_key, size_t master_key_length,
 350                                        char **keys, size_t *key_length,
 351                                        unsigned int number_of_keys);
 352
 353 memcached_return memcached_set_by_key(memcached_st *ptr,
 354                                       char *master_key, size_t master_key_length,
 355                                       char *key, size_t key_length,
 356                                       char *value, size_t value_length,
 357                                       time_t expiration,
 358                                       uint32_t flags);
 359
 360 memcached_return memcached_add_by_key(memcached_st *ptr,
 361                                       char *master_key, size_t master_key_length,
 362                                       char *key, size_t key_length,
 363                                       char *value, size_t value_length,
 364                                       time_t expiration,
 365                                       uint32_t flags);
 366
 367 memcached_return memcached_replace_by_key(memcached_st *ptr,
 368                                           char *master_key, size_t master_key_length,
 369                                           char *key, size_t key_length,
 370                                           char *value, size_t value_length,
 371                                           time_t expiration,
 372                                           uint32_t flags);
 373
 374 memcached_return memcached_prepend_by_key(memcached_st *ptr,
 375                                           char *master_key, size_t master_key_length,
 376                                           char *key, size_t key_length,
 377                                           char *value, size_t value_length,
 378                                           time_t expiration,
 379                                           uint32_t flags);
 380
 381 memcached_return memcached_append_by_key(memcached_st *ptr,
 382                                          char *master_key, size_t master_key_length,
 383                                          char *key, size_t key_length,
 384                                          char *value, size_t value_length,
 385                                          time_t expiration,
 386                                          uint32_t flags);
 387
 388 memcached_return memcached_cas_by_key(memcached_st *ptr,
 389                                       char *master_key, size_t master_key_length,
 390                                       char *key, size_t key_length,
 391                                       char *value, size_t value_length,
 392                                       time_t expiration,
 393                                       uint32_t flags,
 394                                       uint64_t cas);
 395 memcached_return memcached_delete_by_key(memcached_st *ptr,
 396                                          char *master_key, size_t master_key_length,
 397                                          char *key, size_t key_length,
 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));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__ */