.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Memcached::libmemcached::memcached_generate_hash_value 3pm"
.TH Memcached::libmemcached::memcached_generate_hash_value 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
memcached_generate_hash_value \- Hash a key value
.SH LIBRARY
.IX Header "LIBRARY"
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  #include <memcached.h>
\&
\&  uint32_t
\&    memcached_generate_hash_value (const char *key,
\&                                   size_t key_length,
\&                                   memcached_hash_t hash_algorithm);
\&
\&  uint32_t 
\&    memcached_generate_hash (memcached_st *ptr,
\&                             const char *key, 
\&                             size_t key_length);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBmemcached_generate_hash_value()\fR allows you to hash a key using one of
the hash functions defined in the library. This method is provided for
the convenience of higher-level language bindings and is not necessary
for normal memcache operations.
.PP
The allowed hash algorithm constants are listed in the manpage for
\&\fBmemcached_behavior_set()\fR.
.PP
\&\fBmemcached_generate_hash()\fR takes a memcached_st struture and produces
the hash value that would have been generated based on the defaults
of the memcached_st structure.
.PP
As of version 0.36 all hash methods have been placed into the library
\&\fBlibhashkit\fR\|(3) which is linked with \fBlibmemcached\fR\|(3).
.SH RETURN
.IX Header "RETURN"
A 32\-bit integer which is the result of hashing the given key.
For 64\-bit hash algorithms, only the least-significant 32 bits are
returned.
.SH HOME
.IX Header "HOME"
To find out more information please check: 
<https://launchpad.net/libmemcached>
.SH AUTHOR
.IX Header "AUTHOR"
Brian Aker, <brian@tangent.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBmemcached\fR\|(1) \fBlibmemcached\fR\|(3) \fBmemcached_behavior_set\fR\|(3) \fBlibhashkit\fR\|(3)