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.  This is mostly a legacy of Eric Young
  25 writing this library for the reasons of implementing what looked like
  26 a nice algorithm rather than for a particular software product.
  27
  28 OPENSSL_LH_stats() prints out statistics on the size of the hash table, how
  29 many entries are in it, and the number and result of calls to the
  30 routines in this library.
  31
  32 OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
  33 hash table.
  34
  35 OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
  36 hash table.  It prints the 'load' and the 'actual load'.  The load is
  37 the average number of data items per 'bucket' in the hash table.  The
  38 'actual load' is the average number of items per 'bucket', but only
  39 for buckets which contain entries.  So the 'actual load' is the
  40 average number of searches that will need to find an item in the hash
  41 table, while the 'load' is the average number that will be done to
  42 record a miss.
  43
  44 OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
  45 are the same as the above, except that the output goes to a B<BIO>.
  46
  47 =head1 RETURN VALUES
  48
  49 These functions do not return values.
  50
  51 =head1 SEE ALSO
  52
  53 L<bio(3)>, L<lhash(3)>
  54
  55 =head1 COPYRIGHT
  56
  57 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  58
  59 Licensed under the OpenSSL license (the "License").  You may not use
  60 this file except in compliance with the License.  You can obtain a copy
  61 in the file LICENSE in the source distribution or at
  62 L<https://www.openssl.org/source/license.html>.
  63
  64 =cut