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 <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <sys/types.h>
  17 #include <sys/socket.h>
  18 #include <netinet/in.h>
  19 #include <arpa/inet.h>
  20 #include <netdb.h>
  21 #include <unistd.h>
  22 #include <limits.h>
  23 #include <assert.h>
  24 #include <time.h>
  25 #include <errno.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 typedef struct memcached_st memcached_st;
  32 typedef struct memcached_stat_st memcached_stat_st;
  33 typedef struct memcached_string_st memcached_string_st;
  34 typedef struct memcached_server_st memcached_server_st;
  35
  36 #define MEMCACHED_DEFAULT_PORT 11211
  37 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  38 #define SMALL_STRING_LEN 1024
  39 #define HUGE_STRING_LEN 8196
  40 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  41 //#define MEMCACHED_MAX_BUFFER 8196
  42 #define MEMCACHED_MAX_BUFFER 8196
  43
  44 typedef enum {
  45   MEMCACHED_SUCCESS,
  46   MEMCACHED_FAILURE,
  47   MEMCACHED_HOST_LOCKUP_FAILURE,
  48   MEMCACHED_CONNECTION_FAILURE,
  49   MEMCACHED_CONNECTION_BIND_FAILURE,
  50   MEMCACHED_WRITE_FAILURE,
  51   MEMCACHED_READ_FAILURE,
  52   MEMCACHED_UNKNOWN_READ_FAILURE,
  53   MEMCACHED_PROTOCOL_ERROR,
  54   MEMCACHED_CLIENT_ERROR,
  55   MEMCACHED_SERVER_ERROR,
  56   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  57   MEMCACHED_DATA_EXISTS,
  58   MEMCACHED_DATA_DOES_NOT_EXIST,
  59   MEMCACHED_NOTSTORED,
  60   MEMCACHED_STORED,
  61   MEMCACHED_NOTFOUND,
  62   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  63   MEMCACHED_PARTIAL_READ,
  64   MEMCACHED_SOME_ERRORS,
  65   MEMCACHED_NO_SERVERS,
  66   MEMCACHED_END,
  67   MEMCACHED_DELETED,
  68   MEMCACHED_VALUE,
  69   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  70 } memcached_return;
  71
  72 typedef enum {
  73   MEMCACHED_BEHAVIOR_NO_BLOCK,
  74   MEMCACHED_BEHAVIOR_BLOCK,
  75   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  76   MEMCACHED_BEHAVIOR_TCP_DELAY,
  77 } memcached_behavior;
  78
  79 typedef enum {
  80   MEMCACHED_NOT_ALLOCATED= 0,
  81   MEMCACHED_ALLOCATED= 1,
  82 } memcached_allocated;
  83
  84 struct memcached_server_st {
  85   char *hostname;
  86   unsigned int port;
  87   int fd;
  88 };
  89
  90 struct memcached_stat_st {
  91   unsigned int pid;
  92   unsigned int uptime;
  93   unsigned int threads;
  94   time_t time;
  95   char version[8];
  96   unsigned int pointer_size;
  97   unsigned int rusage_user;
  98   unsigned int rusage_system;
  99   unsigned int rusage_user_seconds;
 100   unsigned int rusage_user_microseconds;
 101   unsigned int rusage_system_seconds;
 102   unsigned int rusage_system_microseconds;
 103   unsigned int curr_items;
 104   unsigned int total_items;
 105   unsigned long long bytes;
 106   unsigned int curr_connections;
 107   unsigned int total_connections;
 108   unsigned int connection_structures;
 109   unsigned long long cmd_get;
 110   unsigned long long cmd_set;
 111   unsigned long long get_hits;
 112   unsigned long long get_misses;
 113   unsigned long long evictions;
 114   unsigned long long bytes_read;
 115   unsigned long long bytes_written;
 116   unsigned int limit_maxbytes;
 117 };
 118
 119 #define MEM_NO_BLOCK     (1 << 0)
 120 #define MEM_TCP_NODELAY  (1 << 1)
 121 #define MEM_REUSE_MEMORY (1 << 2)
 122
 123 struct memcached_string_st {
 124   char *string;
 125   char *end;
 126   size_t current_size;
 127   size_t block_size;
 128 };
 129
 130 struct memcached_st {
 131   memcached_allocated is_allocated;
 132   memcached_server_st *hosts;
 133   unsigned int number_of_hosts;
 134   unsigned int cursor_server;
 135   char read_buffer[MEMCACHED_MAX_BUFFER];
 136   size_t read_buffer_length;
 137   char *read_ptr;
 138   char write_buffer[MEMCACHED_MAX_BUFFER];
 139   size_t write_buffer_offset;
 140   char connected;
 141   int my_errno;
 142   unsigned int stack_responses;
 143   unsigned long long flags;
 144   memcached_return warning; /* Future Use */
 145 };
 146
 147 /* Public API */
 148 memcached_st *memcached_create(memcached_st *ptr);
 149 void memcached_free(memcached_st *ptr);
 150
 151 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 152                                   time_t expiration);
 153 memcached_return memcached_increment(memcached_st *ptr,
 154                                      char *key, size_t key_length,
 155                                      unsigned int offset,
 156                                      unsigned int *value);
 157 memcached_return memcached_decrement(memcached_st *ptr,
 158                                      char *key, size_t key_length,
 159                                      unsigned int offset,
 160                                      unsigned int *value);
 161 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 162 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 163                                            char *hostname, unsigned int port);
 164 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 165 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 166 void memcached_quit(memcached_st *ptr);
 167 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 168 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 169
 170 /* All of the functions for adding data to the server */
 171 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 172                                char *value, size_t value_length,
 173                                time_t expiration,
 174                                uint16_t  flags);
 175 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 176                                char *value, size_t value_length,
 177                                time_t expiration,
 178                                uint16_t  flags);
 179 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 180                                    char *value, size_t value_length,
 181                                    time_t expiration,
 182                                    uint16_t  flags);
 183
 184 /* Get functions */
 185 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 186                     size_t *value_length,
 187                     uint16_t *flags,
 188                     memcached_return *error);
 189 memcached_return memcached_mget(memcached_st *ptr,
 190                                 char **keys, size_t *key_length,
 191                                 unsigned int number_of_keys);
 192 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 193                       size_t *value_length, uint16_t *flags,
 194                       memcached_return *error);
 195
 196 /* Server Public functions */
 197 #define memcached_server_count(A) A->number_of_hosts
 198 #define memcached_server_name(A,B) B.hostname
 199 #define memcached_server_port(A,B) B.port
 200 #define memcached_server_list(A) A->hosts
 201
 202 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 203                                       unsigned int port);
 204
 205 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 206                                              char *hostname, unsigned int port,
 207                                              memcached_return *error);
 208 void memcached_server_list_free(memcached_server_st *ptr);
 209 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 210 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 211 memcached_server_st *memcached_servers_parse(char *server_strings);
 212
 213 /* String Struct */
 214 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
 215 #define memcached_string_size(A, B) B->current_size
 216 #define memcached_string_value(A, B) B->string
 217
 218 memcached_string_st *memcached_string_create(memcached_st *ptr, size_t initial_size);
 219 memcached_return memcached_string_append_character(memcached_st *ptr,
 220                                                    memcached_string_st *string,
 221                                                    char character);
 222 memcached_return memcached_string_append(memcached_st *ptr, memcached_string_st *string,
 223                                          char *value, size_t length);
 224 size_t memcached_string_backspace(memcached_st *ptr, memcached_string_st *string, size_t remove);
 225 memcached_return memcached_string_reset(memcached_st *ptr, memcached_string_st *string);
 226 void memcached_string_free(memcached_st *ptr, memcached_string_st *string);
 227
 228 /* Some personal debugging functions */
 229 #define WATCHPOINT printf("\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 230 #define WATCHPOINT_ERROR(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 231 #define WATCHPOINT_STRING(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
 232 #define WATCHPOINT_NUMBER(A) printf("\nWATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
 233 #define WATCHPOINT_ERRNO(A) printf("\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, strerror(A));A= 0;fflush(stdout);
 234
 235
 236 #ifdef __cplusplus
 237 }
 238 #endif
 239
 240 #endif /* __MEMCACHED_H__ */