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.
88 lines
2.7 KiB
88 lines
2.7 KiB
.\"
|
|
.\" 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 March 30, 2012
|
|
.Dt CK_HT_ITERATOR_INIT 3
|
|
.Sh NAME
|
|
.Nm ck_ht_iterator_init
|
|
.Nd initialize hash table iterator
|
|
.Sh LIBRARY
|
|
Concurrency Kit (libck, \-lck)
|
|
.Sh SYNOPSIS
|
|
.In ck_ht.h
|
|
.Pp
|
|
.Dv ck_ht_iterator_t iterator = CK_HT_ITERATOR_INITIALIZER
|
|
.Pp
|
|
.Ft void
|
|
.Fn ck_ht_iterator_init "ck_ht_iterator_t *iterator"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn ck_ht_iterator_init
|
|
function will initialize the object pointed to by
|
|
the
|
|
.Fa iterator
|
|
argument. Alternatively, an iterator may be statically initialized
|
|
by assigning it the
|
|
.Dv CK_HT_ITERATOR_INITIALIZER
|
|
value.
|
|
.Pp
|
|
An iterator is used to iterate through hash table entries
|
|
with the
|
|
.Xr ck_ht_next 3
|
|
function.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn ck_ht_iterator_init
|
|
function does not return a value.
|
|
.Sh ERRORS
|
|
This function will not fail.
|
|
.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_reset_size_spmc 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_length 3 ,
|
|
.Xr ck_ht_entry_key 3 ,
|
|
.Xr ck_ht_entry_set 3 ,
|
|
.Xr ck_ht_entry_set_direct 3 ,
|
|
.Xr ck_ht_entry_key_direct 3 ,
|
|
.Xr ck_ht_entry_value 3 ,
|
|
.Xr ck_ht_entry_value_direct 3 ,
|
|
.Xr ck_ht_next 3
|
|
.Pp
|
|
Additional information available at http://concurrencykit.org/
|