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

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Libmemcached library
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions are
  10  *  met:
  11  *
  12  *      * Redistributions of source code must retain the above copyright
  13  *  notice, this list of conditions and the following disclaimer.
  14  *
  15  *      * Redistributions in binary form must reproduce the above
  16  *  copyright notice, this list of conditions and the following disclaimer
  17  *  in the documentation and/or other materials provided with the
  18  *  distribution.
  19  *
  20  *      * The names of its contributors may not be used to endorse or
  21  *  promote products derived from this software without specific prior
  22  *  written permission.
  23  *
  24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  */
  37
  38
  39 #pragma once
  40
  41 #ifndef WIN32
  42 #include <netdb.h>
  43 #endif
  44
  45 enum memcached_server_state_t {
  46   MEMCACHED_SERVER_STATE_NEW, // fd == -1, no address lookup has been done
  47   MEMCACHED_SERVER_STATE_ADDRINFO, // ADDRRESS information has been gathered
  48   MEMCACHED_SERVER_STATE_IN_PROGRESS,
  49   MEMCACHED_SERVER_STATE_CONNECTED,
  50   MEMCACHED_SERVER_STATE_IN_TIMEOUT
  51 };
  52
  53 struct memcached_server_st {
  54   struct {
  55     bool is_allocated:1;
  56     bool is_initialized:1;
  57     bool is_shutting_down:1;
  58     bool is_dead:1;
  59   } options;
  60   uint32_t number_of_hosts;
  61   uint32_t cursor_active;
  62   in_port_t port;
  63   memcached_socket_t fd;
  64   uint32_t io_bytes_sent; /* # bytes sent since last read */
  65   uint32_t server_failure_counter;
  66   uint64_t server_failure_counter_query_id;
  67   uint32_t weight;
  68   uint32_t version;
  69   enum memcached_server_state_t state;
  70   struct {
  71     uint32_t read;
  72     uint32_t write;
  73   } io_wait_count;
  74   uint8_t major_version; // Default definition of UINT8_MAX means that it has not been set.
  75   uint8_t micro_version; // ditto
  76   uint8_t minor_version; // ditto
  77   memcached_connection_t type;
  78   char *read_ptr;
  79   size_t read_buffer_length;
  80   size_t read_data_length;
  81   size_t write_buffer_offset;
  82   struct addrinfo *address_info;
  83   struct addrinfo *address_info_next;
  84   time_t next_retry;
  85   memcached_st *root;
  86   uint64_t limit_maxbytes;
  87   struct memcached_error_t *error_messages;
  88   char read_buffer[MEMCACHED_MAX_BUFFER];
  89   char write_buffer[MEMCACHED_MAX_BUFFER];
  90   char hostname[NI_MAXHOST];
  91 };
  92
  93
  94 #ifdef __cplusplus
  95 extern "C" {
  96 #endif
  97
  98 LIBMEMCACHED_API
  99 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
 100                                            const memcached_server_fn *callback,
 101                                            void *context,
 102                                            uint32_t number_of_callbacks);
 103
 104 LIBMEMCACHED_API
 105   memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
 106                                                         const char *key,
 107                                                         size_t key_length,
 108                                                         memcached_return_t *error);
 109
 110 LIBMEMCACHED_API
 111 void memcached_server_error_reset(memcached_server_st *ptr);
 112
 113 LIBMEMCACHED_API
 114 void memcached_server_free(memcached_server_st *ptr);
 115
 116 LIBMEMCACHED_LOCAL
 117 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
 118                                             memcached_server_st *source);
 119
 120 LIBMEMCACHED_API
 121 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
 122
 123
 124 LIBMEMCACHED_API
 125 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
 126                                             const char *hostname,
 127                                             in_port_t port);
 128 LIBMEMCACHED_API
 129 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
 130                                                     const char *filename);
 131 LIBMEMCACHED_API
 132 memcached_return_t memcached_server_add(memcached_st *ptr,
 133                                         const char *hostname, in_port_t port);
 134
 135 LIBMEMCACHED_LOCAL
 136   memcached_return_t memcached_server_add_parsed(memcached_st *ptr,
 137                                                  const char *hostname,
 138                                                  size_t hostname_length,
 139                                                  in_port_t port,
 140                                                  uint32_t weight);
 141
 142 LIBMEMCACHED_API
 143 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 144                                                         const char *hostname,
 145                                                         in_port_t port,
 146                                                         uint32_t weight);
 147 LIBMEMCACHED_API
 148 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 149                                                                 const char *filename,
 150                                                                 uint32_t weight);
 151 LIBMEMCACHED_API
 152 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 153                                                     in_port_t port,
 154                                                     uint32_t weight);
 155
 156 /**
 157   Operations on Single Servers.
 158 */
 159 LIBMEMCACHED_API
 160 uint32_t memcached_server_response_count(const memcached_server_instance_st self);
 161
 162 LIBMEMCACHED_API
 163 const char *memcached_server_name(const memcached_server_instance_st self);
 164
 165 LIBMEMCACHED_API
 166 in_port_t memcached_server_port(const memcached_server_instance_st self);
 167
 168 LIBMEMCACHED_API
 169 const char *memcached_server_type(const memcached_server_instance_st ptr);
 170
 171
 172 LIBMEMCACHED_LOCAL
 173 void __server_free(memcached_server_st *);
 174
 175 #ifdef __cplusplus
 176 } // extern "C"
 177 #endif