summaryrefslogtreecommitdiff
path: root/doc/ck_rhs_stat
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_rhs_stat')
-rw-r--r--doc/ck_rhs_stat80
1 files changed, 0 insertions, 80 deletions
diff --git a/doc/ck_rhs_stat b/doc/ck_rhs_stat
deleted file mode 100644
index df45672b9183..000000000000
--- a/doc/ck_rhs_stat
+++ /dev/null
@@ -1,80 +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_STAT 3
-.Sh NAME
-.Nm ck_rhs_stat
-.Nd get hash set status
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_rhs.h
-.Ft void
-.Fn ck_rhs_stat "ck_rhs_t *hs" "struct ck_rhs_stat *st"
-.Sh DESCRIPTION
-The
-.Fn ck_rhs_stat 3
-function will store various hash set statistics in
-the object pointed to by
-.Fa st .
-The ck_rhs_stat structure is defined as follows:
-.Bd -literal -offset indent
-struct ck_rhs_stat {
- unsigned long n_entries; /* Current number of keys in hash set. */
- unsigned int probe_maximum; /* Longest read-side probe sequence. */
-};
-.Ed
-.Sh RETURN VALUES
-.Fn ck_rhs_stat 3
-has no return value.
-.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_rhs_init 3 ,
-.Xr ck_rhs_move 3 ,
-.Xr ck_rhs_destroy 3 ,
-.Xr CK_RHS_HASH 3 ,
-.Xr ck_rhs_iterator_init 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_gc 3 ,
-.Xr ck_rhs_rebuild 3 ,
-.Xr ck_rhs_count 3 ,
-.Xr ck_rhs_reset 3 ,
-.Xr ck_rhs_reset_size 3
-.Pp
-Additional information available at http://concurrencykit.org/