X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_generate_hash_value.3;h=dce9572459e61729ee769fb62b09e53af39e4141;hb=88b37087b2c5e8f7da8876d144549c2e27312c34;hp=5034b0d8f49f6aa1b10546f3def0c42c555f73f0;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_generate_hash_value.3 b/docs/man/memcached_generate_hash_value.3 index 5034b0d8..e499a04c 100644 --- a/docs/man/memcached_generate_hash_value.3 +++ b/docs/man/memcached_generate_hash_value.3 @@ -1,6 +1,6 @@ -.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "October 18, 2011" "1.01" "libmemcached" .SH NAME -memcached_generate_hash_value \- libmemcached Documentation +memcached_generate_hash_value \- Generating hash values directly . .nr rst2man-indent-level 0 . @@ -31,52 +31,46 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .sp -memcached_generate_hash_value -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp Hash a key value -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C #include - -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); -.ft P -.fi +.INDENT 0.0 +.TP +.B uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm); +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length); +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached .SH DESCRIPTION .sp -memcached_generate_hash_value() allows you to hash a key using one of +\fBmemcached_generate_hash_value()\fP 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. .sp The allowed hash algorithm constants are listed in the manpage for -memcached_behavior_set(). +\fBmemcached_behavior_set()\fP. .sp -memcached_generate_hash() takes a memcached_st struture and produces -the hash value that would have been generated based on the defaults -of the memcached_st structure. +\fBmemcached_generate_hash()\fP takes a \fBmemcached_st\fP struture +and produces the hash value that would have been generated based on the +defaults of the \fBmemcached_st structure\fP. .sp As of version 0.36 all hash methods have been placed into the library -libmemcached(3) which is linked with libmemcached(3). +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. +.SH RETURN .sp 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 .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP +\fI\%http://libmemcached.org/\fP +.SH AUTHOR .sp Brian Aker, <\fI\%brian@tangent.org\fP> .SH SEE ALSO @@ -85,7 +79,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .