git.m6w6.name Git - m6w6/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 __MEMCACHED_SERVER_H__
  13 #define __MEMCACHED_SERVER_H__
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 struct memcached_server_st {
  20   struct {
  21     bool is_allocated:1;
  22     bool sockaddr_inited:1;
  23   } options;
  24   uint32_t number_of_hosts;
  25   uint32_t cursor_active;
  26   in_port_t port;
  27   int cached_errno;
  28   int fd;
  29   uint32_t io_bytes_sent; /* # bytes sent since last read */
  30   uint32_t server_failure_counter;
  31   uint32_t weight;
  32   uint8_t major_version;
  33   uint8_t micro_version;
  34   uint8_t minor_version;
  35   memcached_connection_t type;
  36   char *read_ptr;
  37   char *cached_server_error;
  38   size_t read_buffer_length;
  39   size_t read_data_length;
  40   size_t write_buffer_offset;
  41   struct addrinfo *address_info;
  42   time_t next_retry;
  43   memcached_st *root;
  44   uint64_t limit_maxbytes;
  45   char read_buffer[MEMCACHED_MAX_BUFFER];
  46   char write_buffer[MEMCACHED_MAX_BUFFER];
  47   char hostname[MEMCACHED_MAX_HOST_LENGTH];
  48 };
  49
  50 // Local Only Inline
  51 static inline uint32_t memcached_servers_count(memcached_server_st *servers)
  52 {
  53   return servers->number_of_hosts;
  54 }
  55
  56 // Local Only Inline
  57 static inline uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count)
  58 {
  59   return servers->number_of_hosts= count;
  60 }
  61
  62
  63
  64 #define memcached_server_count(A) (A)->number_of_hosts
  65 #define memcached_server_name(A,B) (B).hostname
  66 #define memcached_server_port(A,B) (B).port
  67 #define memcached_server_list(A) (A)->hosts
  68 #define memcached_server_response_count(A) (A)->cursor_active
  69
  70 LIBMEMCACHED_API
  71 memcached_return_t memcached_server_cursor(memcached_st *ptr,
  72                                            memcached_server_fn *callback,
  73                                            void *context,
  74                                            uint32_t number_of_callbacks);
  75
  76 LIBMEMCACHED_API
  77 memcached_server_st *memcached_server_by_key(memcached_st *ptr,
  78                                              const char *key,
  79                                              size_t key_length,
  80                                              memcached_return_t *error);
  81
  82 LIBMEMCACHED_API
  83 const char *memcached_server_error(memcached_server_st *ptr);
  84
  85 LIBMEMCACHED_API
  86 void memcached_server_error_reset(memcached_server_st *ptr);
  87
  88 /* These should not currently be used by end users */
  89 /* TODO: Is the above comment valid? If so, how can we unit test these if they
  90  * aren't exported. If not, we should remove the comment */
  91 LIBMEMCACHED_LOCAL
  92 memcached_server_st *memcached_server_create(memcached_st *memc, memcached_server_st *ptr);
  93
  94 LIBMEMCACHED_LOCAL
  95 memcached_server_st *memcached_server_create_with(memcached_st *memc,
  96                                                   memcached_server_st *host,
  97                                                   const char *hostname,
  98                                                   in_port_t port,
  99                                                   uint32_t weight,
 100                                                   memcached_connection_t type);
 101
 102 LIBMEMCACHED_API
 103 void memcached_server_free(memcached_server_st *ptr);
 104
 105 LIBMEMCACHED_LOCAL
 106 memcached_server_st *memcached_server_clone(memcached_server_st *clone,
 107                                             memcached_server_st *ptr);
 108
 109 LIBMEMCACHED_API
 110 memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
 111
 112 LIBMEMCACHED_API
 113 memcached_server_st *memcached_server_get_last_disconnect(memcached_st *ptr);
 114
 115 #ifdef __cplusplus
 116 }
 117 #endif
 118
 119 #endif /* __MEMCACHED_SERVER_H__ */