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