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_host_st memcached_host_st;
  34
  35 #define MEMCACHED_DEFAULT_PORT 11211
  36 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  37 #define HUGE_STRING_LEN 8196
  38 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  39
  40 #define WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout);
  41
  42 typedef enum {
  43   MEMCACHED_SUCCESS,
  44   MEMCACHED_FAILURE,
  45   MEMCACHED_HOST_LOCKUP_FAILURE,
  46   MEMCACHED_CONNECTION_FAILURE,
  47   MEMCACHED_CONNECTION_BIND_FAILURE,
  48   MEMCACHED_WRITE_FAILURE,
  49   MEMCACHED_READ_FAILURE,
  50   MEMCACHED_UNKNOWN_READ_FAILURE,
  51   MEMCACHED_PROTOCOL_ERROR,
  52   MEMCACHED_CLIENT_ERROR,
  53   MEMCACHED_SERVER_ERROR,
  54   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  55   MEMCACHED_DATA_EXISTS,
  56   MEMCACHED_DATA_DOES_NOT_EXIST,
  57   MEMCACHED_NOTSTORED,
  58   MEMCACHED_NOTFOUND,
  59   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  60   MEMCACHED_PARTIAL_READ,
  61   MEMCACHED_SOME_ERRORS,
  62 } memcached_return;
  63
  64 typedef enum {
  65   MEMCACHED_NOT_ALLOCATED= 0,
  66   MEMCACHED_ALLOCATED= 1,
  67 } memcached_allocated;
  68
  69 struct memcached_host_st {
  70   char *hostname;
  71   unsigned int port;
  72   int fd;
  73 };
  74
  75 struct memcached_stat_st {
  76   unsigned int pid;
  77   unsigned int uptime;
  78   unsigned int threads;
  79   time_t time;
  80   char version[8];
  81   unsigned int pointer_size;
  82   unsigned int rusage_user;
  83   unsigned int rusage_system;
  84   unsigned int rusage_user_seconds;
  85   unsigned int rusage_user_microseconds;
  86   unsigned int rusage_system_seconds;
  87   unsigned int rusage_system_microseconds;
  88   unsigned int curr_items;
  89   unsigned int total_items;
  90   unsigned long long bytes;
  91   unsigned int curr_connections;
  92   unsigned int total_connections;
  93   unsigned int connection_structures;
  94   unsigned long long cmd_get;
  95   unsigned long long cmd_set;
  96   unsigned long long get_hits;
  97   unsigned long long get_misses;
  98   unsigned long long evictions;
  99   unsigned long long bytes_read;
 100   unsigned long long bytes_written;
 101   unsigned int limit_maxbytes;
 102 };
 103
 104 struct memcached_st {
 105   memcached_allocated is_allocated;
 106   memcached_host_st *hosts;
 107   unsigned int number_of_hosts;
 108   unsigned int cursor_server;
 109   char connected;
 110 };
 111
 112 /* Public API */
 113 memcached_st *memcached_init(memcached_st *ptr);
 114 void memcached_deinit(memcached_st *ptr);
 115
 116 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 117                                char *value, size_t value_length,
 118                                time_t expiration,
 119                                uint16_t  flags);
 120 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 121                                char *value, size_t value_length,
 122                                time_t expiration,
 123                                uint16_t  flags);
 124 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 125                                    char *value, size_t value_length,
 126                                    time_t expiration,
 127                                    uint16_t  flags);
 128 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 129                                   time_t expiration);
 130 memcached_return memcached_increment(memcached_st *ptr,
 131                                      char *key, size_t key_length,
 132                                      unsigned int offset,
 133                                      unsigned int *value);
 134 memcached_return memcached_decrement(memcached_st *ptr,
 135                                      char *key, size_t key_length,
 136                                      unsigned int offset,
 137                                      unsigned int *value);
 138 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 139 memcached_return memcached_stat_hostname(memcached_stat_st *stat, char *args,
 140                                          char *hostname, unsigned int port);
 141 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 142 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 143 void memcached_quit(memcached_st *ptr);
 144 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 145                     size_t *value_length,
 146                     uint16_t *flags,
 147                     memcached_return *error);
 148 memcached_return memcached_mget(memcached_st *ptr,
 149                                 char **keys, size_t *key_length,
 150                                 unsigned int number_of_keys);
 151 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 152                       size_t *value_length, uint16_t *flags,
 153                       memcached_return *error);
 154 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 155                                       unsigned int port);
 156 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 157
 158 /* These are all private, do not use. */
 159 memcached_return memcached_connect(memcached_st *ptr);
 160 memcached_return memcached_response(memcached_st *ptr,
 161                                     char *buffer, size_t buffer_length,
 162                                     unsigned int server_key);
 163 unsigned int memcached_generate_hash(char *key, size_t key_length);
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168
 169 #endif /* __MEMCACHED_H__ */