Blame doc/man3/OPENSSL_LH_stats.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
Packit c4476c
OPENSSL_LH_stats_bio,
Packit c4476c
OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/lhash.h>
Packit c4476c
Packit c4476c
 void OPENSSL_LH_stats(LHASH *table, FILE *out);
Packit c4476c
 void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
Packit c4476c
 void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
Packit c4476c
Packit c4476c
 void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
Packit c4476c
 void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
Packit c4476c
 void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The B<LHASH> structure records statistics about most aspects of
Packit c4476c
accessing the hash table.
Packit c4476c
Packit c4476c
OPENSSL_LH_stats() prints out statistics on the size of the hash table, how
Packit c4476c
many entries are in it, and the number and result of calls to the
Packit c4476c
routines in this library.
Packit c4476c
Packit c4476c
OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
Packit c4476c
hash table.
Packit c4476c
Packit c4476c
OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
Packit c4476c
hash table.  It prints the 'load' and the 'actual load'.  The load is
Packit c4476c
the average number of data items per 'bucket' in the hash table.  The
Packit c4476c
'actual load' is the average number of items per 'bucket', but only
Packit c4476c
for buckets which contain entries.  So the 'actual load' is the
Packit c4476c
average number of searches that will need to find an item in the hash
Packit c4476c
table, while the 'load' is the average number that will be done to
Packit c4476c
record a miss.
Packit c4476c
Packit c4476c
OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
Packit c4476c
are the same as the above, except that the output goes to a B<BIO>.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
These functions do not return values.
Packit c4476c
Packit c4476c
=head1 NOTE
Packit c4476c
Packit c4476c
These calls should be made under a read lock. Refer to
Packit c4476c
L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
Packit c4476c
when using the LHASH data structure.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut