git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached-1.0/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 #ifdef NI_MAXHOST
  46 #define MEMCACHED_NI_MAXHOST NI_MAXHOST
  47 #else
  48 #define MEMCACHED_NI_MAXHOST 1025
  49 #endif
  50
  51 enum memcached_server_state_t {
  52   MEMCACHED_SERVER_STATE_NEW, // fd == -1, no address lookup has been done
  53   MEMCACHED_SERVER_STATE_ADDRINFO, // ADDRRESS information has been gathered
  54   MEMCACHED_SERVER_STATE_IN_PROGRESS,
  55   MEMCACHED_SERVER_STATE_CONNECTED,
  56   MEMCACHED_SERVER_STATE_IN_TIMEOUT
  57 };
  58
  59 struct memcached_server_st {
  60   struct {
  61     bool is_allocated:1;
  62     bool is_initialized:1;
  63     bool is_shutting_down:1;
  64     bool is_dead:1;
  65   } options;
  66   uint32_t number_of_hosts;
  67   uint32_t cursor_active;
  68   in_port_t port;
  69   memcached_socket_t fd;
  70   uint32_t io_bytes_sent; /* # bytes sent since last read */
  71   uint32_t server_failure_counter;
  72   uint64_t server_failure_counter_query_id;
  73   uint32_t weight;
  74   uint32_t version;
  75   enum memcached_server_state_t state;
  76   struct {
  77     uint32_t read;
  78     uint32_t write;
  79   } io_wait_count;
  80   uint8_t major_version; // Default definition of UINT8_MAX means that it has not been set.
  81   uint8_t micro_version; // ditto
  82   uint8_t minor_version; // ditto
  83   memcached_connection_t type;
  84   char *read_ptr;
  85   size_t read_buffer_length;
  86   size_t read_data_length;
  87   size_t write_buffer_offset;
  88   struct addrinfo *address_info;
  89   struct addrinfo *address_info_next;
  90   time_t next_retry;
  91   memcached_st *root;
  92   uint64_t limit_maxbytes;
  93   struct memcached_error_t *error_messages;
  94   char read_buffer[MEMCACHED_MAX_BUFFER];
  95   char write_buffer[MEMCACHED_MAX_BUFFER];
  96   char hostname[MEMCACHED_NI_MAXHOST];
  97 };
  98
  99
 100 #ifdef __cplusplus
 101 extern "C" {
 102 #endif
 103
 104 LIBMEMCACHED_API
 105 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
 106                                            const memcached_server_fn *callback,
 107                                            void *context,
 108                                            uint32_t number_of_callbacks);
 109
 110 LIBMEMCACHED_API
 111   memcached_server_instance_st memcached_server_by_key(memcached_st *ptr,
 112                                                        const char *key,
 113                                                        size_t key_length,
 114                                                        memcached_return_t *error);
 115
 116 LIBMEMCACHED_API
 117 void memcached_server_error_reset(memcached_server_st *ptr);
 118
 119 LIBMEMCACHED_API
 120 void memcached_server_free(memcached_server_st *ptr);
 121
 122 LIBMEMCACHED_API
 123 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
 124
 125
 126 LIBMEMCACHED_API
 127 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
 128                                             const char *hostname,
 129                                             in_port_t port);
 130 LIBMEMCACHED_API
 131 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
 132                                                     const char *filename);
 133 LIBMEMCACHED_API
 134 memcached_return_t memcached_server_add(memcached_st *ptr,
 135                                         const char *hostname, in_port_t port);
 136
 137 LIBMEMCACHED_API
 138 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 139                                                         const char *hostname,
 140                                                         in_port_t port,
 141                                                         uint32_t weight);
 142 LIBMEMCACHED_API
 143 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 144                                                                 const char *filename,
 145                                                                 uint32_t weight);
 146 LIBMEMCACHED_API
 147 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 148                                                     in_port_t port,
 149                                                     uint32_t weight);
 150
 151 /**
 152   Operations on Single Servers.
 153 */
 154 LIBMEMCACHED_API
 155 uint32_t memcached_server_response_count(const memcached_server_instance_st self);
 156
 157 LIBMEMCACHED_API
 158 const char *memcached_server_name(const memcached_server_instance_st self);
 159
 160 LIBMEMCACHED_API
 161 in_port_t memcached_server_port(const memcached_server_instance_st self);
 162
 163 LIBMEMCACHED_API
 164 const char *memcached_server_type(const memcached_server_instance_st ptr);
 165
 166 #ifdef __cplusplus
 167 } // extern "C"
 168 #endif