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

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary: String structure used for libmemcached.
   9  *
  10  */
  11
  12 #ifndef __LIBMEMCACHED_SERVER_H__
  13 #define __LIBMEMCACHED_SERVER_H__
  14
  15
  16 struct memcached_server_st {
  17   struct {
  18     bool is_allocated:1;
  19     bool is_initialized:1;
  20     bool is_shutting_down:1;
  21     bool is_dead:1;
  22   } options;
  23   uint32_t number_of_hosts;
  24   uint32_t cursor_active;
  25   in_port_t port;
  26   int cached_errno;
  27   memcached_socket_t fd;
  28   uint32_t io_bytes_sent; /* # bytes sent since last read */
  29   uint32_t server_failure_counter;
  30   uint32_t weight;
  31   struct {
  32     uint32_t read;
  33     uint32_t write;
  34   } io_wait_count;
  35   uint8_t major_version; // Default definition of UINT8_MAX means that it has not been set.
  36   uint8_t micro_version; // ditto
  37   uint8_t minor_version; // ditto
  38   memcached_connection_t type;
  39   char *read_ptr;
  40   char *cached_server_error;
  41   size_t read_buffer_length;
  42   size_t read_data_length;
  43   size_t write_buffer_offset;
  44   struct addrinfo *address_info;
  45   struct addrinfo *address_info_next;
  46   time_t next_retry;
  47   const memcached_st *root;
  48   uint64_t limit_maxbytes;
  49   char read_buffer[MEMCACHED_MAX_BUFFER];
  50   char write_buffer[MEMCACHED_MAX_BUFFER];
  51   char hostname[NI_MAXHOST];
  52 };
  53
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 LIBMEMCACHED_API
  60 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
  61                                            const memcached_server_fn *callback,
  62                                            void *context,
  63                                            uint32_t number_of_callbacks);
  64
  65 LIBMEMCACHED_API
  66   memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
  67                                                         const char *key,
  68                                                         size_t key_length,
  69                                                         memcached_return_t *error);
  70
  71 LIBMEMCACHED_API
  72 void memcached_server_error_reset(memcached_server_st *ptr);
  73
  74 LIBMEMCACHED_API
  75 void memcached_server_free(memcached_server_st *ptr);
  76
  77 LIBMEMCACHED_LOCAL
  78 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
  79                                             const memcached_server_st *source);
  80
  81 LIBMEMCACHED_API
  82 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
  83
  84
  85 LIBMEMCACHED_API
  86 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
  87                                             const char *hostname,
  88                                             in_port_t port);
  89 LIBMEMCACHED_API
  90 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
  91                                                     const char *filename);
  92 LIBMEMCACHED_API
  93 memcached_return_t memcached_server_add(memcached_st *ptr,
  94                                         const char *hostname, in_port_t port);
  95
  96 LIBMEMCACHED_LOCAL
  97   memcached_return_t memcached_server_add_parsed(memcached_st *ptr,
  98                                                  const char *hostname,
  99                                                  size_t hostname_length,
 100                                                  in_port_t port,
 101                                                  uint32_t weight);
 102
 103 LIBMEMCACHED_API
 104 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
 105                                                         const char *hostname,
 106                                                         in_port_t port,
 107                                                         uint32_t weight);
 108 LIBMEMCACHED_API
 109 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 110                                                                 const char *filename,
 111                                                                 uint32_t weight);
 112 LIBMEMCACHED_API
 113 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 114                                                     in_port_t port,
 115                                                     uint32_t weight);
 116
 117 /**
 118   Operations on Single Servers.
 119 */
 120 LIBMEMCACHED_API
 121 uint32_t memcached_server_response_count(memcached_server_instance_st self);
 122
 123 LIBMEMCACHED_API
 124 const char *memcached_server_name(memcached_server_instance_st self);
 125
 126 LIBMEMCACHED_API
 127 in_port_t memcached_server_port(memcached_server_instance_st self);
 128
 129 LIBMEMCACHED_API
 130 const char *memcached_server_error(memcached_server_instance_st ptr);
 131
 132
 133
 134 #ifdef __cplusplus
 135 } // extern "C"
 136 #endif
 137
 138 #endif /* __LIBMEMCACHED_SERVER_H__ */