doc/ck_ht_stat: Add ck_ht_stat manual page.

ck_pring
Samy Al Bahra 12 years ago
parent 51f45d6cbb
commit 2ced93ca08

@ -26,6 +26,7 @@ OBJECTS=ck_ht_count \
ck_ht_entry_value \
ck_ht_iterator_init \
ck_ht_next \
ck_ht_stat \
ck_bitmap_init \
ck_bitmap_reset_mpmc \
ck_bitmap_set_mpmc \

@ -48,6 +48,7 @@ Behavior is undefined if
.Fa ht
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -58,6 +58,7 @@ has no return value.
This function is guaranteed not to fail.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_hash 3 ,
.Xr ck_ht_hash_direct 3 ,

@ -61,6 +61,7 @@ Behavior is undefined if
.Fa entry
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -59,6 +59,7 @@ Behavior is undefined if
.Fa entry
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -62,6 +62,7 @@ Behavior is undefined if
.Fa entry
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -59,6 +59,7 @@ Behavior is undefined if
.Fa entry
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -64,6 +64,7 @@ has no return value.
.Sh ERRORS
This function will never fail.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -59,6 +59,7 @@ has no return value.
.Sh ERRORS
This function will never fail.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -66,6 +66,7 @@ has no return value.
.Sh ERRORS
This function will never fail.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -65,6 +65,7 @@ has no return value.
.Sh ERRORS
This function will never fail.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -59,6 +59,7 @@ Behavior is undefined if
.Fa entry
has not been initialized or if the key is empty.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -60,6 +60,7 @@ Behavior is undefined if
.Fa entry
has not been initialized or if the key is empty.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -148,6 +148,7 @@ if the key as specified in
was not found in the hash table.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -69,6 +69,7 @@ is uninitialized. The function will only return
if there are internal memory allocation failures.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -61,6 +61,7 @@ or if
is uninitialized.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash_direct 3 ,

@ -61,6 +61,7 @@ value or if
is uninitialized.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -154,6 +154,7 @@ is not a pointer to a
object.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,
.Xr ck_ht_hash_direct 3 ,

@ -60,6 +60,7 @@ 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 ,

@ -78,6 +78,7 @@ or
.Fa ht
are uninitialized.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -117,6 +117,7 @@ in
was already present in the hash table.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -88,6 +88,7 @@ If the entry could not be found then
will return
.Dv false.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -52,6 +52,7 @@ and will otherwise return
This function will only fail if a replacement hash table
could not be allocated internally.
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -111,6 +111,7 @@ if the hash table required to be grown but failed
while attempting to grow.
.El
.Sh SEE ALSO
.Xr ck_ht_stat 3 ,
.Xr ck_ht_init 3 ,
.Xr ck_ht_destroy 3 ,
.Xr ck_ht_hash 3 ,

@ -0,0 +1,82 @@
.\"
.\" Copyright 2012 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_HT_STAT 3
.Sh NAME
.Nm ck_ht_stat
.Nd get hash table status
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_ht.h
.Ft void
.Fn ck_ht_stat "ck_ht_t *ht" "struct ck_ht_stat *st"
.Sh DESCRIPTION
The
.Fn ck_ht_stat 3
function will store various hash set statistics in the object
pointed to by
.Fa st .
The ck_ht_stat structure is defined as follows:
.Bd -literal -offset indent
struct ck_ht_stat {
uint64_t probe_maximum; /* Longest read-side probe sequence. */
uint64_t n_entries; /* Current number of keys in hash set. */
};
.Sh RETURN VALUES
.Fn ck_ht_stat 3
has no return value.
.Sh ERRORS
Behavior is undefined if
.Fa ht
has not been initialized.
.Sh SEE ALSO
.Xr ck_ht_count 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_reset 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 3 ,
.Xr ck_ht_entry_key_length 3 ,
.Xr ck_ht_entry_value 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_direct 3 ,
.Xr ck_ht_iterator_init 3 ,
.Xr ck_ht_next 3
.Pp
Additional information available at http://concurrencykit.org/
Loading…
Cancel
Save