git.m6w6.name Git - m6w6/libmemcached/blob - libhashkit-1.0/types.h

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  HashKit
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2009 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 typedef enum {
  42   HASHKIT_SUCCESS,
  43   HASHKIT_FAILURE,
  44   HASHKIT_MEMORY_ALLOCATION_FAILURE,
  45   HASHKIT_INVALID_HASH,
  46   HASHKIT_INVALID_ARGUMENT,
  47   HASHKIT_MAXIMUM_RETURN /* Always add new error code before */
  48 } hashkit_return_t;
  49
  50 static inline bool hashkit_success(const hashkit_return_t rc)
  51 {
  52   return (rc == HASHKIT_SUCCESS);
  53 }
  54
  55 static inline bool hashkit_failed(const hashkit_return_t rc)
  56 {
  57   return (rc != HASHKIT_SUCCESS);
  58 }
  59
  60 typedef enum {
  61   HASHKIT_HASH_DEFAULT= 0, // hashkit_one_at_a_time()
  62   HASHKIT_HASH_MD5,
  63   HASHKIT_HASH_CRC,
  64   HASHKIT_HASH_FNV1_64,
  65   HASHKIT_HASH_FNV1A_64,
  66   HASHKIT_HASH_FNV1_32,
  67   HASHKIT_HASH_FNV1A_32,
  68   HASHKIT_HASH_HSIEH,
  69   HASHKIT_HASH_MURMUR,
  70   HASHKIT_HASH_JENKINS,
  71   HASHKIT_HASH_CUSTOM,
  72   HASHKIT_HASH_MAX
  73 } hashkit_hash_algorithm_t;
  74
  75 /**
  76  * Hash distributions that are available to use.
  77  */
  78 typedef enum
  79 {
  80   HASHKIT_DISTRIBUTION_MODULA,
  81   HASHKIT_DISTRIBUTION_RANDOM,
  82   HASHKIT_DISTRIBUTION_KETAMA,
  83   HASHKIT_DISTRIBUTION_MAX /* Always add new values before this. */
  84 } hashkit_distribution_t;
  85
  86 #ifdef __cplusplus
  87 extern "C" {
  88 #endif
  89
  90 typedef struct hashkit_st hashkit_st;
  91
  92 typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context);
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif