First merge of Trond's patches (cherry picking).
[m6w6/libmemcached] / libmemcached / memcached_server.h
index ca81b0d32caba2b2df4f4958acaa8843eedb041b..f2d92dc1249517776ed1c34d6e1a7d187c5ab62c 100644 (file)
@@ -1,9 +1,12 @@
-/*
- * Summary: String structure used for libmemcached.
+/* LibMemcached
+ * Copyright (C) 2006-2009 Brian Aker 
+ * All rights reserved.
+ *
+ * Use and distribution licensed under the BSD license.  See
+ * the COPYING file in the parent directory for full text.
  *
- * Copy: See Copyright for the status of this software.
+ * Summary: String structure used for libmemcached.
  *
- * Author: Brian Aker
  */
 
 #ifndef __MEMCACHED_SERVER_H__
@@ -14,31 +17,34 @@ extern "C" {
 #endif
 
 struct memcached_server_st {
-  memcached_allocated is_allocated;
-  char hostname[MEMCACHED_MAX_HOST_LENGTH];
-  unsigned int port;
-  int fd;
+  struct {
+    bool is_allocated:1;
+  } options;
+  bool sockaddr_inited;
+  uint16_t count;
+  uint32_t cursor_active;
+  in_port_t port;
   int cached_errno;
-  unsigned int cursor_active;
-  char write_buffer[MEMCACHED_MAX_BUFFER];
-  size_t write_buffer_offset;
-  char read_buffer[MEMCACHED_MAX_BUFFER];
-  size_t read_data_length;
-  size_t read_buffer_length;
-  char *read_ptr;
-  memcached_allocated sockaddr_inited;
-  struct addrinfo *address_info;
-  memcached_connection type;
+  int fd;
+  uint32_t io_bytes_sent; /* # bytes sent since last read */
+  uint32_t server_failure_counter;
+  uint32_t weight;
   uint8_t major_version;
-  uint8_t minor_version;
   uint8_t micro_version;
-  uint16_t count;
+  uint8_t minor_version;
+  memcached_connection_t type;
+  char *read_ptr;
+  char *cached_server_error;
+  size_t read_buffer_length;
+  size_t read_data_length;
+  size_t write_buffer_offset;
+  struct addrinfo *address_info;
   time_t next_retry;
   memcached_st *root;
   uint64_t limit_maxbytes;
-  uint32_t server_failure_counter;
-  uint32_t io_bytes_sent; /* # bytes sent since last read */
-  uint32_t weight;
+  char read_buffer[MEMCACHED_MAX_BUFFER];
+  char write_buffer[MEMCACHED_MAX_BUFFER];
+  char hostname[MEMCACHED_MAX_HOST_LENGTH];
 };
 
 #define memcached_server_count(A) (A)->number_of_hosts
@@ -47,24 +53,46 @@ struct memcached_server_st {
 #define memcached_server_list(A) (A)->hosts
 #define memcached_server_response_count(A) (A)->cursor_active
 
-memcached_return memcached_server_cursor(memcached_st *ptr, 
-                                         memcached_server_function *callback,
-                                         void *context,
-                                         unsigned int number_of_callbacks);
+LIBMEMCACHED_API
+memcached_return_t memcached_server_cursor(memcached_st *ptr,
+                                           memcached_server_fn *callback,
+                                           void *context,
+                                           uint32_t number_of_callbacks);
+
+LIBMEMCACHED_API
+memcached_server_st *memcached_server_by_key(memcached_st *ptr,  const char *key,
+                                             size_t key_length, memcached_return_t *error);
 
-memcached_server_st *memcached_server_by_key(memcached_st *ptr,  const char *key, 
-                                             size_t key_length, memcached_return *error);
+LIBMEMCACHED_API
+const char *memcached_server_error(memcached_server_st *ptr);
+
+LIBMEMCACHED_API
+void memcached_server_error_reset(memcached_server_st *ptr);
 
 /* These should not currently be used by end users */
+/* TODO: Is the above comment valid? If so, how can we unit test these if they
+ * aren't exported. If not, we should remove the comment */
+LIBMEMCACHED_API
 memcached_server_st *memcached_server_create(memcached_st *memc, memcached_server_st *ptr);
 
-memcached_server_st *memcached_server_create_with(memcached_st *memc, memcached_server_st *host, 
-                                                  const char *hostname, unsigned int port, 
-                                                  uint32_t weight, memcached_connection type);
+LIBMEMCACHED_API
+memcached_server_st *memcached_server_create_with(memcached_st *memc, memcached_server_st *host,
+                                                  const char *hostname, in_port_t port,
+                                                  uint32_t weight, memcached_connection_t type);
 
+LIBMEMCACHED_API
 void memcached_server_free(memcached_server_st *ptr);
+LIBMEMCACHED_API
 memcached_server_st *memcached_server_clone(memcached_server_st *clone, memcached_server_st *ptr);
+LIBMEMCACHED_API
+memcached_analysis_st *memcached_analyze(memcached_st *memc, memcached_stat_st *memc_stat,
+                                         memcached_return_t *error);
+
+LIBMEMCACHED_API
+memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
 
+LIBMEMCACHED_API
+memcached_server_st *memcached_server_get_last_disconnect(memcached_st *ptr);
 
 #ifdef __cplusplus
 }