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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>Set Hash Function
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
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>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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=
"Available Hashes" href=
"hashkit_functions.html" />
40 <link rel=
"prev" title=
"Creating a hashkit structure" href=
"hashkit_create.html" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
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><ul>
92 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/index_advanced.html">Advanced Topics
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/index_deprecated.html">Deprecated Functionality
</a></li>
99 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached/index_misc.html">Misc
</a><ul>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/configuration.html">Configuration
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/constants.html">Constants
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/examples.html">Examples
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcached/versioning.html">Versioning
</a></li>
107 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
109 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a><ul>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcachedutil/memcached_pool.html">Working with memcached pools
</a></li>
115 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
118 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libhashkit API
</a><ul class=
"current">
119 <li class=
"toctree-l2"><a class=
"reference internal" href=
"hashkit_create.html">Creating a hashkit structure
</a></li>
120 <li class=
"toctree-l2 current"><a class=
"current reference internal" href=
"#">Set Hash Function
</a></li>
121 <li class=
"toctree-l2"><a class=
"reference internal" href=
"hashkit_functions.html">Available Hashes
</a></li>
122 <li class=
"toctree-l2"><a class=
"reference internal" href=
"hashkit_value.html">Generate hash value
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a><ul>
129 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility
</a></li>
130 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcat.html">memcat - “cat” data from a server
</a></li>
131 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcp.html">memcp - Copy data to a server
</a></li>
132 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memdump.html">memdump - Dumping your server
</a></li>
133 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memerror.html">memerror - translate an error code to a string
</a></li>
134 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memflush.html">memflush - flush all data from a server
</a></li>
135 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memrm.html">memrm - Remove data from a server
</a></li>
136 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memslap.html">memslap - Load testing and benchmarking a server
</a></li>
137 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memaslap.html">memaslap - Load testing and benchmarking a server
</a></li>
138 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memstat.html">memstat - Gather statistics from a server
</a></li>
139 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memexist.html">memexist - Check for the existence of a key
</a></li>
140 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memparse.html">memparse - Parse an option string
</a></li>
141 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memping.html">memping - Test to see if a server is available.
</a></li>
142 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memtouch.html">memtouch - Touches a key.
</a></li>
153 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
156 <nav class=
"wy-nav-top" aria-label=
"top navigation">
158 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
159 <a href=
"../index.html">libmemcached
</a>
164 <div class=
"wy-nav-content">
166 <div class=
"rst-content">
184 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
186 <ul class=
"wy-breadcrumbs">
188 <li><a href=
"../index.html">Docs
</a> »</li>
190 <li><a href=
"index.html">libhashkit API
</a> »</li>
192 <li>Set Hash Function
</li>
195 <li class=
"wy-breadcrumbs-aside">
206 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
207 <div itemprop=
"articleBody">
209 <div class=
"section" id=
"set-hash-function">
210 <h1>Set Hash Function
<a class=
"headerlink" href=
"#set-hash-function" title=
"Permalink to this headline">¶
</a></h1>
211 <span class=
"target" id=
"index-0"></span><p id=
"index-1">Set hash functions to use for calculating values for keys
</p>
212 <div class=
"section" id=
"synopsis">
213 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
215 <dt>#include
<libhashkit-
1.0/hashkit.h
></dt><dd><p>Compile and link with -lhashkit
</p>
219 <dt id=
"_CPPv415hashkit_hash_fn">
220 <span id=
"_CPPv315hashkit_hash_fn"></span><span id=
"_CPPv215hashkit_hash_fn"></span><span id=
"hashkit_hash_fn"></span><em class=
"property">typedef
</em>uint32_t (*
<code class=
"sig-name descname">hashkit_hash_fn
</code>)
<span class=
"sig-paren">(
</span><em class=
"property">const
</em> char *key, size_t key_length, void *context
<span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv415hashkit_hash_fn" title=
"Permalink to this definition">¶
</a><br /></dt>
223 <dl class=
"function">
224 <dt id=
"_CPPv420hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t">
225 <span id=
"_CPPv320hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t"></span><span id=
"_CPPv220hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t"></span><span id=
"hashkit_set_function__hashkit_stP.hashkit_hash_algorithm_t"></span>hashkit_return_t
<code class=
"sig-name descname">hashkit_set_function
</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>, hashkit_hash_algorithm_t
<em>hash_algorithm
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv420hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t" title=
"Permalink to this definition">¶
</a><br /></dt>
228 <dl class=
"function">
229 <dt id=
"_CPPv427hashkit_set_custom_functionP10hashkit_st15hashkit_hash_fnPv">
230 <span id=
"_CPPv327hashkit_set_custom_functionP10hashkit_st15hashkit_hash_fnPv"></span><span id=
"_CPPv227hashkit_set_custom_functionP10hashkit_st15hashkit_hash_fnPv"></span><span id=
"hashkit_set_custom_function__hashkit_stP.hashkit_hash_fn.voidP"></span>hashkit_return_t
<code class=
"sig-name descname">hashkit_set_custom_function
</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>,
<a class=
"reference internal" href=
"#_CPPv415hashkit_hash_fn" title=
"hashkit_hash_fn">hashkit_hash_fn
</a> <em>function
</em>, void *
<em>context
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv427hashkit_set_custom_functionP10hashkit_st15hashkit_hash_fnPv" title=
"Permalink to this definition">¶
</a><br /></dt>
233 <dl class=
"function">
234 <dt id=
"_CPPv420hashkit_get_functionPK10hashkit_st">
235 <span id=
"_CPPv320hashkit_get_functionPK10hashkit_st"></span><span id=
"_CPPv220hashkit_get_functionPK10hashkit_st"></span><span id=
"hashkit_get_function__hashkit_stCP"></span>hashkit_hash_algorithm_t
<code class=
"sig-name descname">hashkit_get_function
</code><span class=
"sig-paren">(
</span><em class=
"property">const
</em> <a class=
"reference internal" href=
"hashkit_create.html#_CPPv410hashkit_st" title=
"hashkit_st">hashkit_st
</a> *
<em>hash
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv420hashkit_get_functionPK10hashkit_st" title=
"Permalink to this definition">¶
</a><br /></dt>
238 <dl class=
"function">
239 <dt id=
"_CPPv433hashkit_set_distribution_functionP10hashkit_st24hashkit_hash_algorithm_t">
240 <span id=
"_CPPv333hashkit_set_distribution_functionP10hashkit_st24hashkit_hash_algorithm_t"></span><span id=
"_CPPv233hashkit_set_distribution_functionP10hashkit_st24hashkit_hash_algorithm_t"></span><span id=
"hashkit_set_distribution_function__hashkit_stP.hashkit_hash_algorithm_t"></span>hashkit_return_t
<code class=
"sig-name descname">hashkit_set_distribution_function
</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>, hashkit_hash_algorithm_t
<em>hash_algorithm
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv433hashkit_set_distribution_functionP10hashkit_st24hashkit_hash_algorithm_t" title=
"Permalink to this definition">¶
</a><br /></dt>
243 <dl class=
"function">
244 <dt id=
"_CPPv440hashkit_set_custom_distribution_functionP10hashkit_st15hashkit_hash_fnPv">
245 <span id=
"_CPPv340hashkit_set_custom_distribution_functionP10hashkit_st15hashkit_hash_fnPv"></span><span id=
"_CPPv240hashkit_set_custom_distribution_functionP10hashkit_st15hashkit_hash_fnPv"></span><span id=
"hashkit_set_custom_distribution_function__hashkit_stP.hashkit_hash_fn.voidP"></span>hashkit_return_t
<code class=
"sig-name descname">hashkit_set_custom_distribution_function
</code><span class=
"sig-paren">(
</span><a class=
"reference internal" href=
"hashkit_create.html#_CPPv410hashkit_st" title=
"hashkit_st">hashkit_st
</a> *
<em>self
</em>,
<a class=
"reference internal" href=
"#_CPPv415hashkit_hash_fn" title=
"hashkit_hash_fn">hashkit_hash_fn
</a> <em>function
</em>, void *
<em>context
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv440hashkit_set_custom_distribution_functionP10hashkit_st15hashkit_hash_fnPv" title=
"Permalink to this definition">¶
</a><br /></dt>
248 <dl class=
"function">
249 <dt id=
"_CPPv433hashkit_get_distribution_functionPK10hashkit_st">
250 <span id=
"_CPPv333hashkit_get_distribution_functionPK10hashkit_st"></span><span id=
"_CPPv233hashkit_get_distribution_functionPK10hashkit_st"></span><span id=
"hashkit_get_distribution_function__hashkit_stCP"></span>hashkit_hash_algorithm_t
<code class=
"sig-name descname">hashkit_get_distribution_function
</code><span class=
"sig-paren">(
</span><em class=
"property">const
</em> <a class=
"reference internal" href=
"hashkit_create.html#_CPPv410hashkit_st" title=
"hashkit_st">hashkit_st
</a> *
<em>self
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv433hashkit_get_distribution_functionPK10hashkit_st" title=
"Permalink to this definition">¶
</a><br /></dt>
254 <div class=
"section" id=
"description">
255 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
256 <p>These functions are used to set and retrieve the key and distribution hash functions.
</p>
258 <div class=
"section" id=
"return-value">
259 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
260 <p><a class=
"reference internal" href=
"#_CPPv420hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t" title=
"hashkit_set_function"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">hashkit_set_function()
</span></code></a>,
<a class=
"reference internal" href=
"#_CPPv427hashkit_set_custom_functionP10hashkit_st15hashkit_hash_fnPv" title=
"hashkit_set_custom_function"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">hashkit_set_custom_function()
</span></code></a> and the distribution equivalents
261 return
<code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">hashkit_return_t
</span></code> <code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">HASHKIT_SUCCESS
</span></code> on success.
</p>
262 <p><a class=
"reference internal" href=
"#_CPPv420hashkit_get_functionPK10hashkit_st" title=
"hashkit_get_function"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">hashkit_get_function()
</span></code></a> and
<a class=
"reference internal" href=
"#_CPPv433hashkit_get_distribution_functionPK10hashkit_st" title=
"hashkit_get_distribution_function"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">hashkit_get_distribution_function()
</span></code></a> return
<code class=
"xref cpp cpp-type docutils literal notranslate"><span class=
"pre">hashkit_hash_algorithm_t
</span></code>
263 indicating the hash function used.
</p>
265 <div class=
"section" id=
"see-also">
266 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
268 <li><p><a class=
"reference internal" href=
"../libhashkit.html"><span class=
"doc">libhashkit - C/C++ hashing library
</span></a></p></li>
269 <li><p><a class=
"reference internal" href=
"hashkit_create.html"><span class=
"doc">Creating a hashkit structure
</span></a></p></li>
270 <li><p><a class=
"reference internal" href=
"hashkit_functions.html"><span class=
"doc">Available Hashes
</span></a></p></li>
281 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
283 <a href=
"hashkit_functions.html" class=
"btn btn-neutral float-right" title=
"Available Hashes" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
286 <a href=
"hashkit_create.html" class=
"btn btn-neutral float-left" title=
"Creating a hashkit structure" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
293 <div role=
"contentinfo">
295 © <a href=
"../copyright.html">Copyright
</a>
299 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>.
312 <script type=
"text/javascript">
314 SphinxRtdTheme.Navigation.enable(true);