Merge lp:~tangent-org/libmemcached/1.0-build/ Build: jenkins-Libmemcached-187
[m6w6/libmemcached] / libhashkit-1.0 / hashkit.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * HashKit library
4 *
5 * Copyright (C) 2011-2012 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
40
41
42 #pragma once
43
44
45 #if !defined(__cplusplus)
46 # include <stdbool.h>
47 #endif
48 #include <inttypes.h>
49 #include <sys/types.h>
50
51 #include <libhashkit-1.0/visibility.h>
52 #include <libhashkit-1.0/configure.h>
53 #include <libhashkit-1.0/types.h>
54 #include <libhashkit-1.0/has.h>
55 #include <libhashkit-1.0/algorithm.h>
56 #include <libhashkit-1.0/behavior.h>
57 #include <libhashkit-1.0/digest.h>
58 #include <libhashkit-1.0/function.h>
59 #include <libhashkit-1.0/str_algorithm.h>
60 #include <libhashkit-1.0/strerror.h>
61 #include <libhashkit-1.0/string.h>
62
63 struct hashkit_st
64 {
65 struct hashkit_function_st {
66 hashkit_hash_fn function;
67 void *context;
68 } base_hash, distribution_hash;
69
70 struct {
71 bool is_base_same_distributed:1;
72 } flags;
73
74 struct {
75 bool is_allocated:1;
76 } options;
77
78 void *_key;
79 };
80
81 #ifdef __cplusplus
82 extern "C" {
83 #endif
84
85 HASHKIT_API
86 hashkit_st *hashkit_create(hashkit_st *hash);
87
88 HASHKIT_API
89 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
90
91 HASHKIT_API
92 bool hashkit_compare(const hashkit_st *first, const hashkit_st *second);
93
94 HASHKIT_API
95 void hashkit_free(hashkit_st *hash);
96
97 HASHKIT_API
98 hashkit_string_st *hashkit_encrypt(hashkit_st *,
99 const char* source, size_t source_length);
100
101 HASHKIT_API
102 hashkit_string_st *hashkit_decrypt(hashkit_st *,
103 const char* source, size_t source_length);
104
105 HASHKIT_API
106 bool hashkit_key(hashkit_st *, const char *key, const size_t key_length);
107
108 #ifdef __cplusplus
109 } // extern "C"
110 #endif