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 sockaddr_inited:1;
  21     bool is_shutting_down:1;
  22   } options;
  23   uint32_t number_of_hosts;
  24   uint32_t cursor_active;
  25   in_port_t port;
  26   int cached_errno;
  27   int fd;
  28   uint32_t io_bytes_sent; /* # bytes sent since last read */
  29   uint32_t server_failure_counter;
  30   uint32_t weight;
  31   struct { // Place any "state" sort variables in here.
  32     bool is_corked:1;
  33     bool is_dead:1;
  34   } state;
  35   uint8_t major_version;
  36   uint8_t micro_version;
  37   uint8_t minor_version;
  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   time_t next_retry;
  46   const memcached_st *root;
  47   uint64_t limit_maxbytes;
  48   char read_buffer[MEMCACHED_MAX_BUFFER];
  49   char write_buffer[MEMCACHED_MAX_BUFFER];
  50   char hostname[NI_MAXHOST];
  51 };
  52
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 LIBMEMCACHED_API
  59 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
  60                                            const memcached_server_fn *callback,
  61                                            void *context,
  62                                            uint32_t number_of_callbacks);
  63
  64 LIBMEMCACHED_API
  65   memcached_server_instance_st memcached_server_by_key(const memcached_st *ptr,
  66                                                         const char *key,
  67                                                         size_t key_length,
  68                                                         memcached_return_t *error);
  69
  70 LIBMEMCACHED_API
  71 void memcached_server_error_reset(memcached_server_st *ptr);
  72
  73 LIBMEMCACHED_API
  74 void memcached_server_free(memcached_server_st *ptr);
  75
  76 LIBMEMCACHED_LOCAL
  77 memcached_server_st *memcached_server_clone(memcached_server_st *destination,
  78                                             const memcached_server_st *source);
  79
  80 LIBMEMCACHED_API
  81 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
  82
  83
  84 LIBMEMCACHED_API
  85 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
  86                                             const char *hostname,
  87                                             in_port_t port);
  88 LIBMEMCACHED_API
  89 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
  90                                                     const char *filename);
  91 LIBMEMCACHED_API
  92 memcached_return_t memcached_server_add(memcached_st *ptr,
  93                                         const char *hostname, in_port_t port);
  94
  95 LIBMEMCACHED_API
  96 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
  97                                                         const char *hostname,
  98                                                         in_port_t port,
  99                                                         uint32_t weight);
 100 LIBMEMCACHED_API
 101 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
 102                                                                 const char *filename,
 103                                                                 uint32_t weight);
 104 LIBMEMCACHED_API
 105 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
 106                                                     in_port_t port,
 107                                                     uint32_t weight);
 108
 109 /**
 110   Operations on Single Servers.
 111 */
 112 LIBMEMCACHED_API
 113 uint32_t memcached_server_response_count(memcached_server_instance_st self);
 114
 115 LIBMEMCACHED_API
 116 const char *memcached_server_name(memcached_server_instance_st self);
 117
 118 LIBMEMCACHED_API
 119 in_port_t memcached_server_port(memcached_server_instance_st self);
 120
 121 LIBMEMCACHED_API
 122 const char *memcached_server_error(memcached_server_instance_st ptr);
 123
 124
 125
 126 #ifdef __cplusplus
 127 } // extern "C"
 128 #endif
 129
 130 #endif /* __LIBMEMCACHED_SERVER_H__ */