You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
89 lines
2.6 KiB
89 lines
2.6 KiB
10 years ago
|
.\"
|
||
|
|
.\" Copyright 2012-2013 Samy Al Bahra.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||
|
|
.\" SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.\"
|
||
|
|
.Dd September 17, 2012
|
||
|
|
.Dt CK_RHS_GET 3
|
||
|
|
.Sh NAME
|
||
|
|
.Nm ck_rhs_get
|
||
|
|
.Nd load a key from a hash set
|
||
|
|
.Sh LIBRARY
|
||
|
|
Concurrency Kit (libck, \-lck)
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In ck_rhs.h
|
||
|
|
.Ft void *
|
||
|
|
.Fn ck_rhs_get "ck_rhs_t *hs" "unsigned long hash" "const void *key"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn ck_rhs_get 3
|
||
|
|
function will return a pointer to a key in the hash set
|
||
|
|
.Fa hs
|
||
|
|
that is of equivalent value to the object pointed to by
|
||
|
|
.Fa key .
|
||
|
|
The key specified by
|
||
|
|
.Fa key
|
||
|
|
is expected to have the hash value specified by the
|
||
|
|
.Fa hash
|
||
|
|
argument (which is to have been previously generated using the
|
||
|
|
.Xr CK_RHS_HASH 3
|
||
|
|
macro).
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
If the provided key is a member of
|
||
|
|
.Fa hs
|
||
|
|
then a pointer to the key as stored in
|
||
|
|
.Fa hs
|
||
|
|
is returned. If the key was not found in
|
||
|
|
.Fa hs
|
||
|
|
then a value of
|
||
|
|
.Dv NULL
|
||
|
|
is returned.
|
||
|
|
.Sh ERRORS
|
||
|
|
Behavior is undefined if
|
||
|
|
.Fa entry
|
||
|
|
or
|
||
|
|
.Fa hs
|
||
|
|
are uninitialized.
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr ck_rhs_init 3 ,
|
||
|
|
.Xr ck_rhs_move 3 ,
|
||
|
|
.Xr ck_rhs_destroy 3 ,
|
||
|
|
.Xr CK_RHS_HASH 3 ,
|
||
|
|
.Xr ck_rhs_iterator_init 3 ,
|
||
|
|
.Xr ck_rhs_next 3 ,
|
||
|
|
.Xr ck_rhs_put 3 ,
|
||
|
|
.Xr ck_rhs_put_unique 3 ,
|
||
|
|
.Xr ck_rhs_set 3 ,
|
||
|
|
.Xr ck_rhs_fas 3 ,
|
||
|
|
.Xr ck_rhs_remove 3 ,
|
||
|
|
.Xr ck_rhs_grow 3 ,
|
||
|
|
.Xr ck_rhs_rebuild 3 ,
|
||
|
|
.Xr ck_rhs_gc 3 ,
|
||
|
|
.Xr ck_rhs_count 3 ,
|
||
|
|
.Xr ck_rhs_reset 3 ,
|
||
|
|
.Xr ck_rhs_reset_size 3 ,
|
||
|
|
.Xr ck_rhs_stat 3
|
||
|
|
.Pp
|
||
|
|
Additional information available at http://concurrencykit.org/
|