update docs
[m6w6/libmemcached] / libhashkit / hashkit_value.html
1
2
3 <!DOCTYPE html>
4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>Generate hash value &mdash; libmemcached 1.0.99 documentation</title>
12
13
14
15
16
17
18
19
20 <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21
22
23 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24 <script src="../_static/jquery.js"></script>
25 <script src="../_static/underscore.js"></script>
26 <script src="../_static/doctools.js"></script>
27 <script src="../_static/language_data.js"></script>
28
29 <script type="text/javascript" src="../_static/js/theme.js"></script>
30
31
32
33
34 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
35 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
36 <link rel="index" title="Index" href="../genindex.html" />
37 <link rel="search" title="Search" href="../search.html" />
38 <link rel="copyright" title="Copyright" href="../copyright.html" />
39 <link rel="next" title="Client Applications" href="../bin/index.html" />
40 <link rel="prev" title="Available Hashes" href="hashkit_functions.html" />
41 </head>
42
43 <body class="wy-body-for-nav">
44
45
46 <div class="wy-grid-for-nav">
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search" >
51
52
53
54 <a href="../index.html" class="icon icon-home"> libmemcached
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 1.0
65 </div>
66
67
68
69
70 <div role="search">
71 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76 </div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85
86
87
88 <p class="caption"><span class="caption-text">libmemcached</span></p>
89 <ul>
90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
91 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
93 </ul>
94 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
95 <ul>
96 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
97 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
98 </ul>
99 <p class="caption"><span class="caption-text">libhashkit</span></p>
100 <ul class="current">
101 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
102 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libhashkit API</a><ul class="current">
103 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a></li>
104 <li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
105 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html">Available Hashes</a></li>
106 <li class="toctree-l2 current"><a class="current reference internal" href="#">Generate hash value</a></li>
107 </ul>
108 </li>
109 </ul>
110 <p class="caption"><span class="caption-text">Client Applications</span></p>
111 <ul>
112 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
113 </ul>
114 <p class="caption"><span class="caption-text">Copyright</span></p>
115 <ul>
116 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
117 </ul>
118
119
120
121 </div>
122 </div>
123 </nav>
124
125 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
126
127
128 <nav class="wy-nav-top" aria-label="top navigation">
129
130 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
131 <a href="../index.html">libmemcached</a>
132
133 </nav>
134
135
136 <div class="wy-nav-content">
137
138 <div class="rst-content">
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156 <div role="navigation" aria-label="breadcrumbs navigation">
157
158 <ul class="wy-breadcrumbs">
159
160 <li><a href="../index.html">Docs</a> &raquo;</li>
161
162 <li><a href="index.html">libhashkit API</a> &raquo;</li>
163
164 <li>Generate hash value</li>
165
166
167 <li class="wy-breadcrumbs-aside">
168
169
170
171 </li>
172
173 </ul>
174
175
176 <hr/>
177 </div>
178 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
179 <div itemprop="articleBody">
180
181 <div class="section" id="generate-hash-value">
182 <h1>Generate hash value<a class="headerlink" href="#generate-hash-value" title="Permalink to this headline"></a></h1>
183 <div class="section" id="synopsis">
184 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
185 <dl class="simple">
186 <dt>#include &lt;libhashkit-1.0/hashkit.h&gt;</dt><dd><p>Compile and link with -lhashkit</p>
187 </dd>
188 </dl>
189 <dl class="function">
190 <dt id="_CPPv413hashkit_valueP10hashkit_stPKc6size_t">
191 <span id="_CPPv313hashkit_valueP10hashkit_stPKc6size_t"></span><span id="_CPPv213hashkit_valueP10hashkit_stPKc6size_t"></span><span id="hashkit_value__hashkit_stP.cCP.s"></span>uint32_t <code class="sig-name descname">hashkit_value</code><span class="sig-paren">(</span><a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="Permalink to this definition"></a><br /></dt>
192 <dd></dd></dl>
193
194 </div>
195 <div class="section" id="description">
196 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
197 <p>The <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_value()</span></code></a> function generates a 32-bit hash value from the given key
198 and key_length. The hash argument is an initialized hashkit object, and
199 distribution type and hash function is used from this object while generating
200 the value.</p>
201 </div>
202 <div class="section" id="return-value">
203 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline"></a></h2>
204 <p>A 32-bit hash value.</p>
205 </div>
206 <div class="section" id="see-also">
207 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
208 <ul class="simple">
209 <li><p><a class="reference internal" href="../libhashkit.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></p></li>
210 <li><p><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></p></li>
211 <li><p><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></p></li>
212 <li><p><a class="reference internal" href="hashkit_functions.html"><span class="doc">Available Hashes</span></a></p></li>
213 </ul>
214 </div>
215 </div>
216
217
218 </div>
219
220 </div>
221 <footer>
222
223 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
224
225 <a href="../bin/index.html" class="btn btn-neutral float-right" title="Client Applications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
226
227
228 <a href="hashkit_functions.html" class="btn btn-neutral float-left" title="Available Hashes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
229
230 </div>
231
232
233 <hr/>
234
235 <div role="contentinfo">
236 <p>
237 &copy; <a href="../copyright.html">Copyright</a>
238
239 </p>
240 </div>
241 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
242
243 </footer>
244
245 </div>
246 </div>
247
248 </section>
249
250 </div>
251
252
253
254 <script type="text/javascript">
255 jQuery(function () {
256 SphinxRtdTheme.Navigation.enable(true);
257 });
258 </script>
259
260
261
262
263
264
265 </body>
266 </html>