crypto/external/bsd/openssl/dist/doc/ssl/SSL_CTX_sess_number.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_sess_number, SSL_CTX_sess_connect, SSL_CTX_sess_connect_good, SSL_CTX_sess_connect_renegotiate, SSL_CTX_sess_accept, SSL_CTX_sess_accept_good, SSL_CTX_sess_accept_renegotiate, SSL_CTX_sess_hits, SSL_CTX_sess_cb_hits, SSL_CTX_sess_misses, SSL_CTX_sess_timeouts, SSL_CTX_sess_cache_full - obtain session cache statistics
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  long SSL_CTX_sess_number(SSL_CTX *ctx);
  12  long SSL_CTX_sess_connect(SSL_CTX *ctx);
  13  long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
  14  long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
  15  long SSL_CTX_sess_accept(SSL_CTX *ctx);
  16  long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
  17  long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
  18  long SSL_CTX_sess_hits(SSL_CTX *ctx);
  19  long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
  20  long SSL_CTX_sess_misses(SSL_CTX *ctx);
  21  long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
  22  long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
  23
  24 =head1 DESCRIPTION
  25
  26 SSL_CTX_sess_number() returns the current number of sessions in the internal
  27 session cache.
  28
  29 SSL_CTX_sess_connect() returns the number of started SSL/TLS handshakes in
  30 client mode.
  31
  32 SSL_CTX_sess_connect_good() returns the number of successfully established
  33 SSL/TLS sessions in client mode.
  34
  35 SSL_CTX_sess_connect_renegotiate() returns the number of start renegotiations
  36 in client mode.
  37
  38 SSL_CTX_sess_accept() returns the number of started SSL/TLS handshakes in
  39 server mode.
  40
  41 SSL_CTX_sess_accept_good() returns the number of successfully established
  42 SSL/TLS sessions in server mode.
  43
  44 SSL_CTX_sess_accept_renegotiate() returns the number of start renegotiations
  45 in server mode.
  46
  47 SSL_CTX_sess_hits() returns the number of successfully reused sessions.
  48 In client mode a session set with L<SSL_set_session(3)|SSL_set_session(3)>
  49 successfully reused is counted as a hit. In server mode a session successfully
  50 retrieved from internal or external cache is counted as a hit.
  51
  52 SSL_CTX_sess_cb_hits() returns the number of successfully retrieved sessions
  53 from the external session cache in server mode.
  54
  55 SSL_CTX_sess_misses() returns the number of sessions proposed by clients
  56 that were not found in the internal session cache in server mode.
  57
  58 SSL_CTX_sess_timeouts() returns the number of sessions proposed by clients
  59 and either found in the internal or external session cache in server mode,
  60  but that were invalid due to timeout. These sessions are not included in
  61 the SSL_CTX_sess_hits() count.
  62
  63 SSL_CTX_sess_cache_full() returns the number of sessions that were removed
  64 because the maximum session cache size was exceeded.
  65
  66 =head1 RETURN VALUES
  67
  68 The functions return the values indicated in the DESCRIPTION section.
  69
  70 =head1 SEE ALSO
  71
  72 L<ssl(3)|ssl(3)>, L<SSL_set_session(3)|SSL_set_session(3)>,
  73 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>
  74 L<SSL_CTX_sess_set_cache_size(3)|SSL_CTX_sess_set_cache_size(3)>
  75
  76 =cut