git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/server.h

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary: String structure used for libmemcached.
   9  *
  10  */
  11
  12 #ifndef __LIBMEMCACHED_SERVER_H__
  13 #define __LIBMEMCACHED_SERVER_H__
  14
  15
  16 struct memcached_server_st {
  17   struct {
  18     bool is_allocated MEMCACHED_BITFIELD;
  19     bool is_initialized MEMCACHED_BITFIELD;
  20     bool sockaddr_inited MEMCACHED_BITFIELD;
  21     bool is_shutting_down MEMCACHED_BITFIELD;
  22   } options;
  23   uint32_t number_of_hosts;
  24   uint32_t cursor_active;
  25   in_port_t port;
  26   int cached_errno;
  27   int fd;
  28   uint32_t io_bytes_sent; /* # bytes sent since last read */
  29   uint32_t server_failure_counter;
  30   uint32_t weight;
  31   struct { // Place any "state" sort variables in here.
  32     bool is_corked;
  33   } state;
  34   uint8_t major_version;
  35   uint8_t micro_version;
  36   uint8_t minor_version;
  37   memcached_connection_t type;
  38   char *read_ptr;
  39   char *cached_server_error;
  40   size_t read_buffer_length;
  41   size_t read_data_length;
  42   size_t write_buffer_offset;
  43   struct addrinfo *address_info;
  44   time_t next_retry;
  45   const memcached_st *root;
  46   uint64_t limit_maxbytes;
  47   char read_buffer[MEMCACHED_MAX_BUFFER];
  48   char write_buffer[MEMCACHED_MAX_BUFFER];
  49   char hostname[NI_MAXHOST];
  50 };
  51
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 LIBMEMCACHED_API
  58 memcached_return_t memcached_server_cursor(memcached_st *ptr,
  59                                            memcached_server_fn *callback,
  60                                            void *context,
  61                                            uint32_t number_of_callbacks);
  62
  63 LIBMEMCACHED_API
  64 memcached_server_st *memcached_server_by_key(memcached_st *ptr,
  65                                              const char *key,
  66                                              size_t key_length,
  67                                              memcached_return_t *error);
  68
  69 LIBMEMCACHED_API
  70 const char *memcached_server_error(memcached_server_st *ptr);
  71
  72 LIBMEMCACHED_API
  73 void memcached_server_error_reset(memcached_server_st *ptr);
  74
  75 /* These should not currently be used by end users */
  76 /* TODO: Is the above comment valid? If so, how can we unit test these if they
  77  * aren't exported. If not, we should remove the comment */
  78
  79 LIBMEMCACHED_LOCAL
  80 memcached_server_st *memcached_server_create_with(const memcached_st *memc,
  81                                                   memcached_server_st *host,
  82                                                   const char *hostname,
  83                                                   in_port_t port,
  84                                                   uint32_t weight,
  85                                                   memcached_connection_t type);
  86
  87 LIBMEMCACHED_API
  88 void memcached_server_free(memcached_server_st *ptr);
  89
  90 LIBMEMCACHED_LOCAL
  91 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
  92                                             const memcached_server_st *source);
  93
  94 LIBMEMCACHED_API
  95 memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
  96
  97 LIBMEMCACHED_API
  98 memcached_server_st *memcached_server_get_last_disconnect(memcached_st *ptr);
  99
 100
 101 LIBMEMCACHED_API
 102 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
 103                                             const char *hostname,
 104                                             in_port_t port);
 105 LIBMEMCACHED_API
 106 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
 107                                                     const char *filename);
 108 LIBMEMCACHED_API
 109 memcached_return_t memcached_server_add(memcached_st *ptr,
 110                                         const char *hostname, in_port_t port);
 111
 112 LIBMEMCACHED_API
 113 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 114                                                         const char *hostname,
 115                                                         in_port_t port,
 116                                                         uint32_t weight);
 117 LIBMEMCACHED_API
 118 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 119                                                                 const char *filename,
 120                                                                 uint32_t weight);
 121 LIBMEMCACHED_API
 122 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 123                                                     in_port_t port,
 124                                                     uint32_t weight);
 125 /* Server List Public functions */
 126
 127 LIBMEMCACHED_API
 128 void memcached_server_list_free(memcached_server_st *ptr);
 129
 130
 131 LIBMEMCACHED_API
 132 memcached_return_t memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 133
 134 LIBMEMCACHED_API
 135 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 136                                                   const char *hostname,
 137                                                   in_port_t port,
 138                                                   memcached_return_t *error);
 139 LIBMEMCACHED_API
 140 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 141                                                               const char *hostname,
 142                                                               in_port_t port,
 143                                                               uint32_t weight,
 144                                                               memcached_return_t *error);
 145 LIBMEMCACHED_API
 146 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 147
 148 // Local Only Inline
 149 static inline uint32_t memcached_servers_count(memcached_server_st *servers)
 150 {
 151   return servers->number_of_hosts;
 152 }
 153
 154 // Local Only Inline
 155 static inline uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count)
 156 {
 157   return servers->number_of_hosts= count;
 158 }
 159
 160
 161 #define memcached_server_count(A) (A)->number_of_hosts
 162 #define memcached_server_name(A,B) (B).hostname
 163 #define memcached_server_port(A,B) (B).port
 164 #define memcached_server_list(A) (A)->servers
 165 #define memcached_server_list_set(A,B) (A)->servers=(B)
 166 #define memcached_server_response_count(A) (A)->cursor_active
 167
 168 #ifdef __cplusplus
 169 } // extern "C"
 170 #endif
 171
 172 #endif /* __LIBMEMCACHED_SERVER_H__ */