This commit also fixes incorrect references to non-existent ck_ht_reset function (replaced with ck_ht_reset_spmc).ck_pring
Samy Al Bahra
12 years ago
parent
8718912993
commit
c9ecf8e210
@ -0,0 +1,83 @@
|
||||
.\"
|
||||
.\" 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 May 5, 2013
|
||||
.Dt CK_HT_RESET_SPMC 3
|
||||
.Sh NAME
|
||||
.Nm ck_ht_reset_size_spmc
|
||||
.Nd remove all entries from a hash table and reset size
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_ht.h
|
||||
.Ft bool
|
||||
.Fn ck_ht_reset_size_spmc "ck_ht_t *ht" "uint64_t capacity"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn ck_ht_reset_size_spmc
|
||||
function will remove all key-value pairs stored in the hash
|
||||
table pointed to by the
|
||||
.Fa ht
|
||||
argument and create a new generation of the hash table that
|
||||
is preallocated for
|
||||
.Fa capacity
|
||||
entries.
|
||||
.Sh RETURN VALUES
|
||||
If successful,
|
||||
.Fn ck_ht_reset_size_spmc
|
||||
will return
|
||||
.Dv true
|
||||
and will otherwise return
|
||||
.Dv false.
|
||||
This function will only fail if a replacement hash table
|
||||
could not be allocated internally.
|
||||
.Sh SEE ALSO
|
||||
.Xr ck_ht_stat 3 ,
|
||||
.Xr ck_ht_init 3 ,
|
||||
.Xr ck_ht_destroy 3 ,
|
||||
.Xr ck_ht_hash 3 ,
|
||||
.Xr ck_ht_hash_direct 3 ,
|
||||
.Xr ck_ht_set_spmc 3 ,
|
||||
.Xr ck_ht_put_spmc 3 ,
|
||||
.Xr ck_ht_get_spmc 3 ,
|
||||
.Xr ck_ht_grow_spmc 3 ,
|
||||
.Xr ck_ht_remove_spmc 3 ,
|
||||
.Xr ck_ht_count 3 ,
|
||||
.Xr ck_ht_entry_empty 3 ,
|
||||
.Xr ck_ht_entry_key_set 3 ,
|
||||
.Xr ck_ht_entry_key_set_direct 3 ,
|
||||
.Xr ck_ht_entry_key 3 ,
|
||||
.Xr ck_ht_entry_key_length 3 ,
|
||||
.Xr ck_ht_entry_value 3 ,
|
||||
.Xr ck_ht_entry_set 3 ,
|
||||
.Xr ck_ht_entry_set_direct 3 ,
|
||||
.Xr ck_ht_reset_spmc 3 ,
|
||||
.Xr ck_ht_entry_key_direct 3 ,
|
||||
.Xr ck_ht_entry_value_direct 3 ,
|
||||
.Xr ck_ht_iterator_init 3 ,
|
||||
.Xr ck_ht_next 3
|
||||
.Pp
|
||||
Additional information available at http://concurrencykit.org/
|
||||
Loading…
Reference in new issue