49351f4dcee3b3e2a953037760819273e1d19765
[openssl.git] / doc / man3 / OPENSSL_LH_stats.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
6 OPENSSL_LH_stats_bio,
7 OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
8
9 =head1 SYNOPSIS
10
11  #include <openssl/lhash.h>
12
13  void OPENSSL_LH_stats(LHASH *table, FILE *out);
14  void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
15  void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
16
17  void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
18  void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
19  void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
20
21 =head1 DESCRIPTION
22
23 The B<LHASH> structure records statistics about most aspects of
24 accessing the hash table.
25
26 OPENSSL_LH_stats() prints out statistics on the size of the hash table, how
27 many entries are in it, and the number and result of calls to the
28 routines in this library.
29
30 OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
31 hash table.
32
33 OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
34 hash table.  It prints the 'load' and the 'actual load'.  The load is
35 the average number of data items per 'bucket' in the hash table.  The
36 'actual load' is the average number of items per 'bucket', but only
37 for buckets which contain entries.  So the 'actual load' is the
38 average number of searches that will need to find an item in the hash
39 table, while the 'load' is the average number that will be done to
40 record a miss.
41
42 OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
43 are the same as the above, except that the output goes to a B<BIO>.
44
45 =head1 RETURN VALUES
46
47 These functions do not return values.
48
49 =head1 SEE ALSO
50
51 L<bio(7)>, L<LHASH(3)>
52
53 =head1 COPYRIGHT
54
55 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
56
57 Licensed under the OpenSSL license (the "License").  You may not use
58 this file except in compliance with the License.  You can obtain a copy
59 in the file LICENSE in the source distribution or at
60 L<https://www.openssl.org/source/license.html>.
61
62 =cut