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