diff options
Diffstat (limited to 'doc/ck_rhs_iterator_init')
-rw-r--r-- | doc/ck_rhs_iterator_init | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/doc/ck_rhs_iterator_init b/doc/ck_rhs_iterator_init deleted file mode 100644 index 4cfd0839eb47..000000000000 --- a/doc/ck_rhs_iterator_init +++ /dev/null @@ -1,78 +0,0 @@ -.\" -.\" 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_ITERATOR_INIT 3 -.Sh NAME -.Nm ck_rhs_iterator_init -.Nd initialize hash set iterator -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh SYNOPSIS -.In ck_rhs.h -.Pp -.Dv ck_rhs_iterator_t iterator = CK_RHS_ITERATOR_INITIALIZER -.Pp -.Ft void -.Fn ck_rhs_iterator_init "ck_rhs_iterator_t *iterator" -.Sh DESCRIPTION -The -.Fn ck_rhs_iterator_init 3 -function will initialize the object pointed to -by the -.Fa iterator -argument. Alternatively, an iterator may be statically -initialized by assigning it to the CK_RHS_ITERATOR_INITIALIZER value. -.Pp -An iterator is used to iterate through hash set entries with the -.Xr ck_rhs_next 3 -function. -.Sh RETURN VALUES -.Fn ck_rhs_iterator_init 3 -has no return value. -.Sh ERRORS -This function will not fail. -.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_next 3 , -.Xr ck_rhs_get 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/ |