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(const memcached_st *ptr,
  59                                            const memcached_server_fn *callback,
  60                                            void *context,
  61                                            uint32_t number_of_callbacks);
  62
  63 LIBMEMCACHED_API
  64   memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
  65                                                         const char *key,
  66                                                         size_t key_length,
  67                                                         memcached_return_t *error);
  68
  69 LIBMEMCACHED_API
  70 void memcached_server_error_reset(memcached_server_st *ptr);
  71
  72 LIBMEMCACHED_API
  73 void memcached_server_free(memcached_server_st *ptr);
  74
  75 LIBMEMCACHED_LOCAL
  76 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
  77                                             const memcached_server_st *source);
  78
  79 LIBMEMCACHED_API
  80 memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
  81
  82 LIBMEMCACHED_API
  83 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
  84
  85
  86 LIBMEMCACHED_API
  87 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
  88                                             const char *hostname,
  89                                             in_port_t port);
  90 LIBMEMCACHED_API
  91 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
  92                                                     const char *filename);
  93 LIBMEMCACHED_API
  94 memcached_return_t memcached_server_add(memcached_st *ptr,
  95                                         const char *hostname, in_port_t port);
  96
  97 LIBMEMCACHED_API
  98 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
  99                                                         const char *hostname,
 100                                                         in_port_t port,
 101                                                         uint32_t weight);
 102 LIBMEMCACHED_API
 103 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 104                                                                 const char *filename,
 105                                                                 uint32_t weight);
 106 LIBMEMCACHED_API
 107 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 108                                                     in_port_t port,
 109                                                     uint32_t weight);
 110 /* Server List Public functions */
 111
 112 LIBMEMCACHED_API
 113 void memcached_server_list_free(memcached_server_st *ptr);
 114
 115
 116 LIBMEMCACHED_API
 117 memcached_return_t memcached_server_push(memcached_st *ptr, const memcached_server_st *list);
 118
 119 LIBMEMCACHED_API
 120 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 121                                                   const char *hostname,
 122                                                   in_port_t port,
 123                                                   memcached_return_t *error);
 124 LIBMEMCACHED_API
 125 memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
 126                                                               const char *hostname,
 127                                                               in_port_t port,
 128                                                               uint32_t weight,
 129                                                               memcached_return_t *error);
 130 LIBMEMCACHED_API
 131 uint32_t memcached_server_list_count(const memcached_server_st *ptr);
 132
 133 LIBMEMCACHED_API
 134 uint32_t memcached_server_count(const memcached_st *);
 135
 136
 137 LIBMEMCACHED_LOCAL
 138 uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count);
 139
 140 LIBMEMCACHED_API
 141 memcached_server_st *memcached_server_list(memcached_st *);
 142
 143 LIBMEMCACHED_LOCAL
 144 void memcached_server_list_set(memcached_st *self, memcached_server_st *list);
 145
 146 /**
 147   Operations on Single Servers.
 148 */
 149 LIBMEMCACHED_API
 150 uint32_t memcached_server_response_count(memcached_server_instance_st self);
 151
 152 LIBMEMCACHED_API
 153 const char *memcached_server_name(memcached_server_instance_st self);
 154
 155 LIBMEMCACHED_API
 156 in_port_t memcached_server_port(memcached_server_instance_st self);
 157
 158 LIBMEMCACHED_API
 159 const char *memcached_server_error(memcached_server_instance_st ptr);
 160
 161
 162
 163 #ifdef __cplusplus
 164 } // extern "C"
 165 #endif
 166
 167 #endif /* __LIBMEMCACHED_SERVER_H__ */