diff options
Diffstat (limited to 'doc/ck_hs_next')
| -rw-r--r-- | doc/ck_hs_next | 92 |
1 files changed, 0 insertions, 92 deletions
diff --git a/doc/ck_hs_next b/doc/ck_hs_next deleted file mode 100644 index 67e083e57080..000000000000 --- a/doc/ck_hs_next +++ /dev/null @@ -1,92 +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_HS_NEXT 3 -.Sh NAME -.Nm ck_hs_next -.Nd iterate to next entry in hash set -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh SYNOPSIS -.In ck_hs.h -.Ft bool -.Fn ck_hs_next "ck_hs_t *hs" "ck_hs_iterator_t *iterator" "void **entry" -.Sh DESCRIPTION -The -.Fn ck_hs_next 3 -function will increment the iterator object pointed to by -.Fa iterator -to point to the next non-empty hash set entry. If -.Fn ck_hs_next 3 -returns true then the pointer pointed to by -.Fa entry -is initialized to the current hash set key pointed to by the -.Fa iterator -object. -.Pp -It is expected that -.Fa iterator -has been initialized using the -.Xr ck_hs_iterator_init 3 -function or statically initialized using CK_HS_ITERATOR_INITIALIZER. -.Sh RETURN VALUES -If -.Fn ck_hs_next 3 -returns true then the object pointed to by -.Fa entry -points to a valid hash set key. If -.Fn ck_hs_next 3 -returns false then the value of the object pointed to by -.Fa entry -is undefined. -.Sh ERRORS -Behavior is undefined if -.Fa iterator -or -.Fa hs -are uninitialized. -.Sh SEE ALSO -.Xr ck_hs_init 3 , -.Xr ck_hs_move 3 , -.Xr ck_hs_destroy 3 , -.Xr CK_HS_HASH 3 , -.Xr ck_hs_iterator_init 3 , -.Xr ck_hs_get 3 , -.Xr ck_hs_put 3 , -.Xr ck_hs_put_unique 3 , -.Xr ck_hs_set 3 , -.Xr ck_hs_fas 3 , -.Xr ck_hs_remove 3 , -.Xr ck_hs_grow 3 , -.Xr ck_hs_rebuild 3 , -.Xr ck_hs_gc 3 , -.Xr ck_hs_count 3 , -.Xr ck_hs_reset 3 , -.Xr ck_hs_reset_size 3 , -.Xr ck_hs_stat 3 -.Pp -Additional information available at http://concurrencykit.org/ |
