lp:794709

[m6w6/libmemcached] / libhashkit / hashkit.h

diff --git a/libhashkit/hashkit.h b/libhashkit/hashkit.h
index 6dd08f43faa87ae39e38c94390bf5422be844a46..9b8761f1c32a53777c882d82a6de16a3f59e304b 100644 (file)
--- a/libhashkit/hashkit.h
+++ b/libhashkit/hashkit.h
@@ -1,92 +1,79 @@
-/* HashKit
- * Copyright (C) 2009 Brian Aker
- * All rights reserved.
+/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ * 
+ *  HashKit library
+ *
+ *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ *  Copyright (C) 2009-2010 Brian Aker All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are
+ *  met:
+ *
+ *      * Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ *      * Redistributions in binary form must reproduce the above
+ *  copyright notice, this list of conditions and the following disclaimer
+ *  in the documentation and/or other materials provided with the
+ *  distribution.
+ *
+ *      * The names of its contributors may not be used to endorse or
+ *  promote products derived from this software without specific prior
+ *  written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * Use and distribution licensed under the BSD license.  See
- * the COPYING file in the parent directory for full text.
  */
 
-/**
- * @file
- * @brief HashKit Header
- */
 
-#ifndef HASHKIT_H
-#define HASHKIT_H
+#pragma once
+
 
 #if !defined(__cplusplus)
 # include <stdbool.h>
 #endif
 #include <inttypes.h>
 #include <sys/types.h>
+
 #include <libhashkit/visibility.h>
+#include <libhashkit/configure.h>
 #include <libhashkit/types.h>
 #include <libhashkit/algorithm.h>
 #include <libhashkit/behavior.h>
+#include <libhashkit/digest.h>
+#include <libhashkit/function.h>
+#include <libhashkit/str_algorithm.h>
 #include <libhashkit/strerror.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @addtogroup hashkit_constants Constants
- * @ingroup hashkit
- * @{
- */
-
-/* Defines. */
-#define HASHKIT_MAX_KEY 251
-#define HASHKIT_POINTS_PER_NODE 100
-#define HASHKIT_POINTS_PER_NODE_WEIGHTED 160
-#define HASHKIT_CONTINUUM_ADDITION 10
-#define HASHKIT_CONTINUUM_KEY_SIZE 86
-
-/** @} */
-
-/**
- * @ingroup hashkit
- */
 struct hashkit_st
 {
-  hashkit_options_st options;
-  hashkit_distribution_t distribution;
-  uint32_t continuum_count;
-  uint32_t continuum_points_count;
-  size_t list_size;
-  size_t context_size;
-
-  /**
-    @note There are two places we use hashing, one is for when we have a key
-    and we want to find out what server it should be placed on. The second is
-    for when we are placing a value into the continuum.
-  */
-  hashkit_hash_algorithm_t for_key;
-  hashkit_hash_algorithm_t for_distribution;
-
-  hashkit_continuum_point_st *continuum;
-  hashkit_fn *hash_fn;
-  hashkit_active_fn *active_fn;
-  hashkit_fn *continuum_hash_fn;
-  hashkit_key_fn *continuum_key_fn;
-  hashkit_sort_fn *sort_fn;
-  hashkit_weight_fn *weight_fn;
-  void *list;
-};
-
-/**
- * @ingroup hashkit
- */
-struct hashkit_continuum_point_st
-{
-  uint32_t index;
-  uint32_t value;
+  struct hashkit_function_st {
+    hashkit_hash_fn function;
+    void *context;
+  } base_hash, distribution_hash;
+
+  struct {
+    bool is_base_same_distributed:1;
+  } flags;
+
+  struct {
+    bool is_allocated:1;
+  } options;
 };
 
-/**
- * @addtogroup hashkit Pandora Hash Declarations
- * @{
- */
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 HASHKIT_API
 hashkit_st *hashkit_create(hashkit_st *hash);
@@ -95,18 +82,14 @@ HASHKIT_API
 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
 
 HASHKIT_API
-void hashkit_free(hashkit_st *hash);
+bool hashkit_compare(const hashkit_st *first, const hashkit_st *second);
 
 HASHKIT_API
-uint32_t hashkit_generate_value(const char *key, size_t key_length, hashkit_hash_algorithm_t hash_algorithm);
+void hashkit_free(hashkit_st *hash);
 
 #define hashkit_is_allocated(__object) ((__object)->options.is_allocated)
 #define hashkit_is_initialized(__object) ((__object)->options.is_initialized)
 
-/** @} */
-
 #ifdef __cplusplus
-}
+} // extern "C"
 #endif
-
-#endif /* HASHKIT_H */