git.m6w6.name Git - m6w6/libmemcached/blob - libhashkit/hashkit.h

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  HashKit library
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2009-2010 Brian Aker All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions are
  10  *  met:
  11  *
  12  *      * Redistributions of source code must retain the above copyright
  13  *  notice, this list of conditions and the following disclaimer.
  14  *
  15  *      * Redistributions in binary form must reproduce the above
  16  *  copyright notice, this list of conditions and the following disclaimer
  17  *  in the documentation and/or other materials provided with the
  18  *  distribution.
  19  *
  20  *      * The names of its contributors may not be used to endorse or
  21  *  promote products derived from this software without specific prior
  22  *  written permission.
  23  *
  24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  */
  37
  38
  39 #pragma once
  40
  41
  42 #if !defined(__cplusplus)
  43 # include <stdbool.h>
  44 #endif
  45 #include <inttypes.h>
  46 #include <sys/types.h>
  47
  48 #include <libhashkit/visibility.h>
  49 #include <libhashkit/configure.h>
  50 #include <libhashkit/types.h>
  51 #include <libhashkit/algorithm.h>
  52 #include <libhashkit/behavior.h>
  53 #include <libhashkit/digest.h>
  54 #include <libhashkit/function.h>
  55 #include <libhashkit/str_algorithm.h>
  56 #include <libhashkit/strerror.h>
  57
  58 struct hashkit_st
  59 {
  60   struct hashkit_function_st {
  61     hashkit_hash_fn function;
  62     void *context;
  63   } base_hash, distribution_hash;
  64
  65   struct {
  66     bool is_base_same_distributed:1;
  67   } flags;
  68
  69   struct {
  70     bool is_allocated:1;
  71   } options;
  72 };
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 HASHKIT_API
  79 hashkit_st *hashkit_create(hashkit_st *hash);
  80
  81 HASHKIT_API
  82 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
  83
  84 HASHKIT_API
  85 bool hashkit_compare(const hashkit_st *first, const hashkit_st *second);
  86
  87 HASHKIT_API
  88 void hashkit_free(hashkit_st *hash);
  89
  90 #define hashkit_is_allocated(__object) ((__object)->options.is_allocated)
  91 #define hashkit_is_initialized(__object) ((__object)->options.is_initialized)
  92
  93 #ifdef __cplusplus
  94 } // extern "C"
  95 #endif