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