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