Fixed a typo that was causing a race condition error.
[m6w6/libmemcached] / libmemcached / memcached.h
index 95592a487490d85a7531123adb716a48a016c98c..a7cdc97722e289e079b79582e4e129cf93965fdf 100644 (file)
  *
  */
 
-#ifndef __MEMCACHED_H__
-#define __MEMCACHED_H__
+#ifndef __LIBMEMCACHED_MEMCACHED_H__
+#define __LIBMEMCACHED_MEMCACHED_H__
 
-#include <stdlib.h>
 #include <inttypes.h>
+#include <netdb.h>
+#include <netinet/in.h>
+#include <stdlib.h>
+#include <sys/types.h>
+
 
 #if !defined(__cplusplus)
 # include <stdbool.h>
 #endif
 
-#include <sys/types.h>
-#include <netinet/in.h>
-
 #include <libmemcached/visibility.h>
-#include <libmemcached/memcached_configure.h>
+#include <libmemcached/configure.h>
 #include <libmemcached/constants.h>
 #include <libmemcached/types.h>
 #include <libmemcached/string.h>
 #include <libmemcached/stats.h>
+#include <libhashkit/hashkit.h>
 // Everything above this line must be in the order specified.
+#include <libmemcached/allocators.h>
 #include <libmemcached/analyze.h>
 #include <libmemcached/auto.h>
 #include <libmemcached/behavior.h>
 #include <libmemcached/callback.h>
+#include <libmemcached/delete.h>
 #include <libmemcached/dump.h>
+#include <libmemcached/fetch.h>
+#include <libmemcached/flush.h>
+#include <libmemcached/flush_buffers.h>
 #include <libmemcached/get.h>
+#include <libmemcached/hash.h>
+#include <libmemcached/parse.h>
+#include <libmemcached/quit.h>
 #include <libmemcached/result.h>
 #include <libmemcached/server.h>
+#include <libmemcached/server_list.h>
 #include <libmemcached/storage.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
+#include <libmemcached/strerror.h>
+#include <libmemcached/verbosity.h>
+#include <libmemcached/version.h>
+#include <libmemcached/sasl.h>
 
 struct memcached_st {
+  /**
+    @note these are static and should not change without a call to behavior.
+  */
   struct {
-    bool is_allocated:1;
-    bool is_initialized:1;
     bool is_purging:1;
-  } options;
-  memcached_server_distribution_t distribution;
-  memcached_hash_t hash;
-  uint32_t continuum_points_counter;
-  memcached_server_st *hosts;
-  memcached_server_st *last_disconnected_server;
-  int32_t snd_timeout;
-  int32_t rcv_timeout;
-  uint32_t server_failure_limit;
-  uint32_t io_msg_watermark;
-  uint32_t io_bytes_watermark;
-  uint32_t io_key_prefetch;
-  uint32_t number_of_hosts;
-  uint32_t cursor_server;
-  int cached_errno;
+    bool is_processing_input:1;
+    bool is_time_for_rebuild:1;
+  } state;
   struct {
+    // Everything below here is pretty static.
     bool auto_eject_hosts:1;
     bool binary_protocol:1;
     bool buffer_requests:1;
+    bool cork:1;
     bool hash_with_prefix_key:1;
     bool ketama_weighted:1;
-    bool no_block:1;
+    bool no_block:1; // Don't block
     bool no_reply:1;
     bool randomize_replica_read:1;
     bool reuse_memory:1;
@@ -80,169 +82,124 @@ struct memcached_st {
     bool use_sort_hosts:1;
     bool use_udp:1;
     bool verify_key:1;
+    bool tcp_keepalive:1;
   } flags;
+  memcached_server_distribution_t distribution;
+  hashkit_st hashkit;
+  uint32_t continuum_points_counter; // Ketama
+  uint32_t number_of_hosts;
+  memcached_server_st *servers;
+  memcached_server_st *last_disconnected_server;
+  int32_t snd_timeout;
+  int32_t rcv_timeout;
+  uint32_t server_failure_limit;
+  uint32_t io_msg_watermark;
+  uint32_t io_bytes_watermark;
+  uint32_t io_key_prefetch;
+  uint32_t tcp_keepidle;
+  int cached_errno;
   int32_t poll_timeout;
   int32_t connect_timeout;
   int32_t retry_timeout;
-  uint32_t continuum_count;
+  uint32_t continuum_count; // Ketama
   int send_size;
   int recv_size;
   void *user_data;
-  time_t next_distribution_rebuild;
+  time_t next_distribution_rebuild; // Ketama
   size_t prefix_key_length;
   uint32_t number_of_replicas;
-  memcached_hash_t distribution_hash;
+  hashkit_st distribution_hashkit;
   memcached_result_st result;
-  memcached_continuum_item_st *continuum;
+  memcached_continuum_item_st *continuum; // Ketama
+
+  struct _allocators_st {
+    memcached_calloc_fn calloc;
+    memcached_free_fn free;
+    memcached_malloc_fn malloc;
+    memcached_realloc_fn realloc;
+    void *context;
+  } allocators;
+
   memcached_clone_fn on_clone;
   memcached_cleanup_fn on_cleanup;
-  memcached_free_fn call_free;
-  memcached_malloc_fn call_malloc;
-  memcached_realloc_fn call_realloc;
-  memcached_calloc_fn call_calloc;
   memcached_trigger_key_fn get_key_failure;
   memcached_trigger_delete_key_fn delete_trigger;
   memcached_callback_st *callbacks;
+  struct memcached_sasl_st *sasl;
   char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
-};
+  struct {
+    bool is_allocated:1;
+  } options;
 
-LIBMEMCACHED_API
-memcached_return_t memcached_version(memcached_st *ptr);
+};
 
-/* Public API */
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 LIBMEMCACHED_API
-const char * memcached_lib_version(void);
+void memcached_servers_reset(memcached_st *ptr);
 
 LIBMEMCACHED_API
 memcached_st *memcached_create(memcached_st *ptr);
-LIBMEMCACHED_API
-void memcached_free(memcached_st *ptr);
-LIBMEMCACHED_API
-memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
-                                  time_t expiration);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
-
-LIBMEMCACHED_API
-void memcached_quit(memcached_st *ptr);
-
-LIBMEMCACHED_API
-const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc);
-
-/* The two public hash bits */
-LIBMEMCACHED_API
-uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash_t hash_algorithm);
-
-LIBMEMCACHED_API
-uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_flush_buffers(memcached_st *mem);
-
-/* Server Public functions */
 
 LIBMEMCACHED_API
-memcached_return_t memcached_server_add_udp(memcached_st *ptr,
-                                            const char *hostname,
-                                            in_port_t port);
-LIBMEMCACHED_API
-memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
-                                                    const char *filename);
-LIBMEMCACHED_API
-memcached_return_t memcached_server_add(memcached_st *ptr,
-                                        const char *hostname, in_port_t port);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
-                                                        const char *hostname,
-                                                        in_port_t port,
-                                                        uint32_t weight);
-LIBMEMCACHED_API
-memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
-                                                                const char *filename,
-                                                                uint32_t weight);
-LIBMEMCACHED_API
-memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
-                                                    in_port_t port,
-                                                    uint32_t weight);
-LIBMEMCACHED_API
-void memcached_server_list_free(memcached_server_st *ptr);
-
-LIBMEMCACHED_API
-memcached_return_t memcached_server_push(memcached_st *ptr, memcached_server_st *list);
-
-LIBMEMCACHED_API
-memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
-                                                  const char *hostname,
-                                                  in_port_t port,
-                                                  memcached_return_t *error);
-LIBMEMCACHED_API
-memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
-                                                              const char *hostname,
-                                                              in_port_t port,
-                                                              uint32_t weight,
-                                                              memcached_return_t *error);
-LIBMEMCACHED_API
-unsigned int memcached_server_list_count(memcached_server_st *ptr);
+void memcached_free(memcached_st *ptr);
 
 LIBMEMCACHED_API
-memcached_server_st *memcached_servers_parse(const char *server_strings);
+void memcached_reset_last_disconnected_server(memcached_st *ptr);
 
 LIBMEMCACHED_API
-char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat,
-                               const char *key, memcached_return_t *error);
-LIBMEMCACHED_API
-char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat,
-                                memcached_return_t *error);
+memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr);
 
 LIBMEMCACHED_API
-memcached_return_t memcached_delete_by_key(memcached_st *ptr,
-                                           const char *master_key, size_t master_key_length,
-                                           const char *key, size_t key_length,
-                                           time_t expiration);
+void *memcached_get_user_data(const memcached_st *ptr);
 
 LIBMEMCACHED_API
-memcached_return_t memcached_fetch_execute(memcached_st *ptr,
-                                           memcached_execute_fn *callback,
-                                           void *context,
-                                           unsigned int number_of_callbacks);
+void *memcached_set_user_data(memcached_st *ptr, void *data);
 
 LIBMEMCACHED_API
-memcached_return_t memcached_set_memory_allocators(memcached_st *ptr,
-                                                   memcached_malloc_fn mem_malloc,
-                                                   memcached_free_fn mem_free,
-                                                   memcached_realloc_fn mem_realloc,
-                                                   memcached_calloc_fn mem_calloc);
+memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source);
 
 LIBMEMCACHED_API
-void memcached_get_memory_allocators(memcached_st *ptr,
-                                     memcached_malloc_fn *mem_malloc,
-                                     memcached_free_fn *mem_free,
-                                     memcached_realloc_fn *mem_realloc,
-                                     memcached_calloc_fn *mem_calloc);
+memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key);
 
 LIBMEMCACHED_API
-void *memcached_get_user_data(memcached_st *ptr);
-LIBMEMCACHED_API
-void *memcached_set_user_data(memcached_st *ptr, void *data);
+uint32_t memcached_server_count(const memcached_st *);
 
-LIBMEMCACHED_LOCAL
-memcached_return_t run_distribution(memcached_st *ptr);
+#ifdef __cplusplus
+} // extern "C"
+#endif
 
-#define memcached_is_allocated(__object) ((__object)->options.is_allocated)
-#define memcached_is_initialized(__object) ((__object)->options.is_initialized)
 
 #ifdef __cplusplus
-}
+class Memcached : private memcached_st {
+public:
+
+  Memcached()
+  {
+    memcached_create(this);
+  }
+
+  ~Memcached()
+  {
+    memcached_free(this);
+  }
+
+  Memcached(const Memcached& source)
+  {
+    memcached_clone(this, &source);
+  }
+
+  Memcached& operator=(const Memcached& source)
+  {
+    memcached_free(this);
+    memcached_clone(this, &source);
+
+    return *this;
+  }
+};
 #endif
 
+#endif /* __LIBMEMCACHED_MEMCACHED_H__ */
 
-#endif /* __MEMCACHED_H__ */