git.m6w6.name Git - awesomized/libmemcached/blob - libhashkit/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 #define hashkit_success(X) ((X) == HASHKIT_SUCCESS)
  51 #define hashkit_failed(X) ((X) != HASHKIT_SUCCESS)
  52
  53 typedef enum {
  54   HASHKIT_HASH_DEFAULT= 0, // hashkit_one_at_a_time()
  55   HASHKIT_HASH_MD5,
  56   HASHKIT_HASH_CRC,
  57   HASHKIT_HASH_FNV1_64,
  58   HASHKIT_HASH_FNV1A_64,
  59   HASHKIT_HASH_FNV1_32,
  60   HASHKIT_HASH_FNV1A_32,
  61   HASHKIT_HASH_HSIEH,
  62   HASHKIT_HASH_MURMUR,
  63   HASHKIT_HASH_JENKINS,
  64   HASHKIT_HASH_CUSTOM,
  65   HASHKIT_HASH_MAX
  66 } hashkit_hash_algorithm_t;
  67
  68 /**
  69  * Hash distributions that are available to use.
  70  */
  71 typedef enum
  72 {
  73   HASHKIT_DISTRIBUTION_MODULA,
  74   HASHKIT_DISTRIBUTION_RANDOM,
  75   HASHKIT_DISTRIBUTION_KETAMA,
  76   HASHKIT_DISTRIBUTION_MAX /* Always add new values before this. */
  77 } hashkit_distribution_t;
  78
  79 #ifdef __cplusplus
  80 extern "C" {
  81 #endif
  82
  83 typedef struct hashkit_st hashkit_st;
  84
  85 typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context);
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif