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
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 typedef struct memcached_st memcached_st;
  22 typedef struct memcached_stat_st memcached_stat_st;
  23 typedef struct memcached_result_st memcached_result_st;
  24 typedef struct memcached_string_st memcached_string_st;
  25 typedef struct memcached_server_st memcached_server_st;
  26
  27 #define MEMCACHED_DEFAULT_PORT 11211
  28 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  29 #define SMALL_STRING_LEN 1024
  30 #define HUGE_STRING_LEN 8196
  31 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  32 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
  33
  34 typedef enum {
  35   MEMCACHED_SUCCESS,
  36   MEMCACHED_FAILURE,
  37   MEMCACHED_HOST_LOCKUP_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_MAXIMUM_RETURN, /* Always add new error code before */
  64 } memcached_return;
  65
  66 typedef enum {
  67   MEMCACHED_BEHAVIOR_NO_BLOCK,
  68   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  69   MEMCACHED_BEHAVIOR_HASH,
  70   MEMCACHED_BEHAVIOR_KETAMA,
  71   MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
  72   MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
  73 } memcached_behavior;
  74
  75 typedef enum {
  76   MEMCACHED_HASH_DEFAULT= 0,
  77   MEMCACHED_HASH_MD5,
  78   MEMCACHED_HASH_CRC,
  79   MEMCACHED_HASH_FNV1_64,
  80   MEMCACHED_HASH_FNV1A_64,
  81   MEMCACHED_HASH_FNV1_32,
  82   MEMCACHED_HASH_FNV1A_32,
  83   MEMCACHED_HASH_KETAMA,
  84 } memcached_hash;
  85
  86 typedef enum {
  87   MEMCACHED_CONNECTION_UNKNOWN,
  88   MEMCACHED_CONNECTION_TCP,
  89   MEMCACHED_CONNECTION_UDP,
  90   MEMCACHED_CONNECTION_UNIX_SOCKET,
  91 } memcached_connection;
  92
  93 typedef enum {
  94   MEMCACHED_NOT_ALLOCATED= 0,
  95   MEMCACHED_ALLOCATED= 1,
  96 } memcached_allocated;
  97
  98 struct memcached_server_st {
  99   char *hostname;
 100   unsigned int port;
 101   int fd;
 102   unsigned int stack_responses;
 103   unsigned int cursor_active;
 104   memcached_connection type;
 105 };
 106
 107 struct memcached_stat_st {
 108   unsigned int pid;
 109   unsigned int uptime;
 110   unsigned int threads;
 111   time_t time;
 112   char version[8];
 113   unsigned int pointer_size;
 114   unsigned int rusage_user;
 115   unsigned int rusage_system;
 116   unsigned int rusage_user_seconds;
 117   unsigned int rusage_user_microseconds;
 118   unsigned int rusage_system_seconds;
 119   unsigned int rusage_system_microseconds;
 120   unsigned int curr_items;
 121   unsigned int total_items;
 122   unsigned long long bytes;
 123   unsigned int curr_connections;
 124   unsigned int total_connections;
 125   unsigned int connection_structures;
 126   unsigned long long cmd_get;
 127   unsigned long long cmd_set;
 128   unsigned long long get_hits;
 129   unsigned long long get_misses;
 130   unsigned long long evictions;
 131   unsigned long long bytes_read;
 132   unsigned long long bytes_written;
 133   unsigned int limit_maxbytes;
 134 };
 135
 136 struct memcached_string_st {
 137   memcached_allocated is_allocated;
 138   char *string;
 139   char *end;
 140   size_t current_size;
 141   size_t block_size;
 142 };
 143
 144 struct memcached_result_st {
 145   memcached_string_st key;
 146   memcached_string_st result;
 147   uint16_t flags;
 148   uint64_t cas;
 149 };
 150
 151 struct memcached_st {
 152   memcached_allocated is_allocated;
 153   memcached_server_st *hosts;
 154   unsigned int number_of_hosts;
 155   unsigned int cursor_server;
 156   char read_buffer[MEMCACHED_MAX_BUFFER];
 157   size_t read_buffer_length;
 158   char *read_ptr;
 159   char write_buffer[MEMCACHED_MAX_BUFFER];
 160   size_t write_buffer_offset;
 161   char connected;
 162   int cached_errno;
 163   unsigned long long flags;
 164   int send_size;
 165   int recv_size;
 166   memcached_string_st result_buffer;
 167   memcached_hash hash;
 168   memcached_return warning; /* Future Use */
 169 };
 170
 171 /* Public API */
 172 memcached_st *memcached_create(memcached_st *ptr);
 173 void memcached_free(memcached_st *ptr);
 174 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 175
 176 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 177                                   time_t expiration);
 178 memcached_return memcached_increment(memcached_st *ptr,
 179                                      char *key, size_t key_length,
 180                                      unsigned int offset,
 181                                      unsigned int *value);
 182 memcached_return memcached_decrement(memcached_st *ptr,
 183                                      char *key, size_t key_length,
 184                                      unsigned int offset,
 185                                      unsigned int *value);
 186 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 187 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 188 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 189                                            char *hostname, unsigned int port);
 190 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 191 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 192 void memcached_quit(memcached_st *ptr);
 193 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 194 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 195 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 196
 197 /* All of the functions for adding data to the server */
 198 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 199                                char *value, size_t value_length,
 200                                time_t expiration,
 201                                uint16_t  flags);
 202 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 203                                char *value, size_t value_length,
 204                                time_t expiration,
 205                                uint16_t  flags);
 206 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 207                                    char *value, size_t value_length,
 208                                    time_t expiration,
 209                                    uint16_t  flags);
 210
 211 /* Get functions */
 212 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 213                     size_t *value_length,
 214                     uint16_t *flags,
 215                     memcached_return *error);
 216 memcached_return memcached_mget(memcached_st *ptr,
 217                                 char **keys, size_t *key_length,
 218                                 unsigned int number_of_keys);
 219 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 220                       size_t *value_length, uint16_t *flags,
 221                       memcached_return *error);
 222 memcached_result_st *memcached_fetch_object(memcached_st *ptr, memcached_return *error);
 223
 224 /* Server Public functions */
 225 #define memcached_server_count(A) A->number_of_hosts
 226 #define memcached_server_name(A,B) B.hostname
 227 #define memcached_server_port(A,B) B.port
 228 #define memcached_server_list(A) A->hosts
 229 #define memcached_server_response_count(A,B) A->hosts[B].stack_responses
 230
 231 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 232                                                   char *filename);
 233 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 234                                       unsigned int port);
 235 void memcached_server_list_free(memcached_server_st *ptr);
 236 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 237
 238 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 239                                              char *hostname, unsigned int port,
 240                                              memcached_return *error);
 241 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 242 memcached_server_st *memcached_servers_parse(char *server_strings);
 243
 244 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 245                                char *key, memcached_return *error);
 246 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 247                                 memcached_return *error);
 248
 249 /* Some personal debugging functions */
 250 #ifdef HAVE_DEBUG
 251 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 252 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 253 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
 254 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
 255 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
 256 #define WATCHPOINT_ASSERT(A) assert((A));
 257 #else
 258 /*
 259 #define WATCHPOINT { 1; };
 260 #define WATCHPOINT_ERROR(A) { 1; };
 261 #define WATCHPOINT_STRING(A) { 1; };
 262 #define WATCHPOINT_NUMBER(A) { 1; };
 263 #define WATCHPOINT_ERRNO(A) { 1; };
 264 #define WATCHPOINT_ASSERT(A) { 1; };
 265 */
 266 #define WATCHPOINT
 267 #define WATCHPOINT_ERROR(A)
 268 #define WATCHPOINT_STRING(A)
 269 #define WATCHPOINT_NUMBER(A)
 270 #define WATCHPOINT_ERRNO(A)
 271 #define WATCHPOINT_ASSERT(A)
 272 #endif
 273
 274
 275 #ifdef __cplusplus
 276 }
 277 #endif
 278
 279 #endif /* __MEMCACHED_H__ */