X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libhashkit%2Ftypes.h;h=66e4cd9c7785ec490665e26c0bb67261c49cdcea;hb=8fa241b9251e81929bd07410e9f598c88ee08242;hp=a06be2fbadf368ba0c1a9f4f0c17d6fc1ce77928;hpb=8fd8f655540e3d6aa0b0a3eb0f4f7df1be2e6542;p=awesomized%2Flibmemcached diff --git a/libhashkit/types.h b/libhashkit/types.h index a06be2fb..66e4cd9c 100644 --- a/libhashkit/types.h +++ b/libhashkit/types.h @@ -1,55 +1,57 @@ - -/* HashKit - * Copyright (C) 2009 Brian Aker - * All rights reserved. +/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab: + * + * HashKit + * + * Copyright (C) 2011 Data Differential, http://datadifferential.com/ + * Copyright (C) 2009 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_TYPES_H -#define HASHKIT_TYPES_H - -#ifdef __cplusplus -extern "C" { -#endif -/** - * @addtogroup hashkit_types Types - * @ingroup hashkit - * @{ - */ +#pragma once typedef enum { HASHKIT_SUCCESS, HASHKIT_FAILURE, HASHKIT_MEMORY_ALLOCATION_FAILURE, + HASHKIT_INVALID_HASH, + HASHKIT_INVALID_ARGUMENT, HASHKIT_MAXIMUM_RETURN /* Always add new error code before */ } hashkit_return_t; -/** - @todo hashkit_options_t is for future use, currently we do not define any user options. - */ - -typedef enum -{ - HASHKIT_OPTION_MAX -} hashkit_options_t; - -typedef struct -{ - /* We use the following for internal book keeping. */ - bool is_initialized:1; - bool is_allocated:1; -} hashkit_options_st; +#define hashkit_success(X) ((X) == HASHKIT_SUCCESS) +#define hashkit_failed(X) ((X) != HASHKIT_SUCCESS) typedef enum { - HASHKIT_HASH_DEFAULT= 0, + HASHKIT_HASH_DEFAULT= 0, // hashkit_one_at_a_time() HASHKIT_HASH_MD5, HASHKIT_HASH_CRC, HASHKIT_HASH_FNV1_64, @@ -59,6 +61,7 @@ typedef enum { HASHKIT_HASH_HSIEH, HASHKIT_HASH_MURMUR, HASHKIT_HASH_JENKINS, + HASHKIT_HASH_CUSTOM, HASHKIT_HASH_MAX } hashkit_hash_algorithm_t; @@ -73,20 +76,14 @@ typedef enum HASHKIT_DISTRIBUTION_MAX /* Always add new values before this. */ } hashkit_distribution_t; +#ifdef __cplusplus +extern "C" { +#endif typedef struct hashkit_st hashkit_st; -typedef struct hashkit_continuum_point_st hashkit_continuum_point_st; -typedef bool (hashkit_active_fn)(void *context); -typedef uint32_t (hashkit_fn)(const char *key, size_t key_length); -typedef size_t (hashkit_key_fn)(char *key, size_t key_length, uint32_t point_index, void *context); -typedef void (hashkit_sort_fn)(void *context, size_t count); -typedef uint32_t (hashkit_weight_fn)(void *context); - -/** @} */ +typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context); #ifdef __cplusplus } #endif - -#endif /* HASHKIT_TYPES_H */