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   uint32_t weight;
  67   uint32_t version;
  68   enum memcached_server_state_t state;
  69   struct {
  70     uint32_t read;
  71     uint32_t write;
  72   } io_wait_count;
  73   uint8_t major_version; // Default definition of UINT8_MAX means that it has not been set.
  74   uint8_t micro_version; // ditto
  75   uint8_t minor_version; // ditto
  76   memcached_connection_t type;
  77   char *read_ptr;
  78   size_t read_buffer_length;
  79   size_t read_data_length;
  80   size_t write_buffer_offset;
  81   struct addrinfo *address_info;
  82   struct addrinfo *address_info_next;
  83   time_t next_retry;
  84   memcached_st *root;
  85   uint64_t limit_maxbytes;
  86   struct memcached_error_t *error_messages;
  87   char read_buffer[MEMCACHED_MAX_BUFFER];
  88   char write_buffer[MEMCACHED_MAX_BUFFER];
  89   char hostname[NI_MAXHOST];
  90 };
  91
  92
  93 #ifdef __cplusplus
  94 extern "C" {
  95 #endif
  96
  97 LIBMEMCACHED_API
  98 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
  99                                            const memcached_server_fn *callback,
 100                                            void *context,
 101                                            uint32_t number_of_callbacks);
 102
 103 LIBMEMCACHED_API
 104   memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
 105                                                         const char *key,
 106                                                         size_t key_length,
 107                                                         memcached_return_t *error);
 108
 109 LIBMEMCACHED_API
 110 void memcached_server_error_reset(memcached_server_st *ptr);
 111
 112 LIBMEMCACHED_API
 113 void memcached_server_free(memcached_server_st *ptr);
 114
 115 LIBMEMCACHED_LOCAL
 116 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
 117                                             memcached_server_st *source);
 118
 119 LIBMEMCACHED_API
 120 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
 121
 122
 123 LIBMEMCACHED_API
 124 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
 125                                             const char *hostname,
 126                                             in_port_t port);
 127 LIBMEMCACHED_API
 128 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
 129                                                     const char *filename);
 130 LIBMEMCACHED_API
 131 memcached_return_t memcached_server_add(memcached_st *ptr,
 132                                         const char *hostname, in_port_t port);
 133
 134 LIBMEMCACHED_LOCAL
 135   memcached_return_t memcached_server_add_parsed(memcached_st *ptr,
 136                                                  const char *hostname,
 137                                                  size_t hostname_length,
 138                                                  in_port_t port,
 139                                                  uint32_t weight);
 140
 141 LIBMEMCACHED_API
 142 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 143                                                         const char *hostname,
 144                                                         in_port_t port,
 145                                                         uint32_t weight);
 146 LIBMEMCACHED_API
 147 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 148                                                                 const char *filename,
 149                                                                 uint32_t weight);
 150 LIBMEMCACHED_API
 151 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 152                                                     in_port_t port,
 153                                                     uint32_t weight);
 154
 155 /**
 156   Operations on Single Servers.
 157 */
 158 LIBMEMCACHED_API
 159 uint32_t memcached_server_response_count(const memcached_server_instance_st self);
 160
 161 LIBMEMCACHED_API
 162 const char *memcached_server_name(const memcached_server_instance_st self);
 163
 164 LIBMEMCACHED_API
 165 in_port_t memcached_server_port(const memcached_server_instance_st self);
 166
 167 LIBMEMCACHED_API
 168 const char *memcached_server_type(const memcached_server_instance_st ptr);
 169
 170
 171 LIBMEMCACHED_LOCAL
 172 void __server_free(memcached_server_st *);
 173
 174 #ifdef __cplusplus
 175 } // extern "C"
 176 #endif