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