aboutsummaryrefslogtreecommitdiff
path: root/doc/ck_hs_reset
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_hs_reset')
-rw-r--r--doc/ck_hs_reset77
1 files changed, 0 insertions, 77 deletions
diff --git a/doc/ck_hs_reset b/doc/ck_hs_reset
deleted file mode 100644
index e6ce72e8c20d..000000000000
--- a/doc/ck_hs_reset
+++ /dev/null
@@ -1,77 +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_RESET 3
-.Sh NAME
-.Nm ck_hs_reset
-.Nd remove all keys from a hash set
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_hs.h
-.Ft bool
-.Fn ck_hs_reset "ck_hs_t *hs"
-.Sh DESCRIPTION
-The
-.Fn ck_hs_reset 3
-function will remove all keys stored in the hash
-set pointed to by the
-.Fa hs
-argument.
-.Sh RETURN VALUES
-If successful,
-.Fn ck_hs_reset 3
-will return true and will otherwise return false on failure. This
-function will only fail if a replacement hash set could not be
-allocated internally.
-.Sh ERRORS
-Behavior is undefined if
-.Fa hs
-is uninitialized. Behavior is
-undefined if this function is called by a non-writer
-thread.
-.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_next 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_reset_size 3 ,
-.Xr ck_hs_grow 3 ,
-.Xr ck_hs_gc 3 ,
-.Xr ck_hs_rebuild 3 ,
-.Xr ck_hs_count 3 ,
-.Xr ck_hs_stat 3
-.Pp
-Additional information available at http://concurrencykit.org/