Blame doc/man3/SSL_CTX_sess_number.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
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
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 long SSL_CTX_sess_number(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_connect(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_accept(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_hits(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_misses(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
Packit Service 084de1
 long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_number() returns the current number of sessions in the internal
Packit Service 084de1
session cache.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_connect() returns the number of started SSL/TLS handshakes in
Packit Service 084de1
client mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_connect_good() returns the number of successfully established
Packit Service 084de1
SSL/TLS sessions in client mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_connect_renegotiate() returns the number of started renegotiations
Packit Service 084de1
in client mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_accept() returns the number of started SSL/TLS handshakes in
Packit Service 084de1
server mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_accept_good() returns the number of successfully established
Packit Service 084de1
SSL/TLS sessions in server mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_accept_renegotiate() returns the number of started renegotiations
Packit Service 084de1
in server mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_hits() returns the number of successfully reused sessions.
Packit Service 084de1
In client mode a session set with L<SSL_set_session(3)>
Packit Service 084de1
successfully reused is counted as a hit. In server mode a session successfully
Packit Service 084de1
retrieved from internal or external cache is counted as a hit.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_cb_hits() returns the number of successfully retrieved sessions
Packit Service 084de1
from the external session cache in server mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_misses() returns the number of sessions proposed by clients
Packit Service 084de1
that were not found in the internal session cache in server mode.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_timeouts() returns the number of sessions proposed by clients
Packit Service 084de1
and either found in the internal or external session cache in server mode,
Packit Service 084de1
 but that were invalid due to timeout. These sessions are not included in
Packit Service 084de1
the SSL_CTX_sess_hits() count.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_sess_cache_full() returns the number of sessions that were removed
Packit Service 084de1
because the maximum session cache size was exceeded.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
The functions return the values indicated in the DESCRIPTION section.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<ssl(7)>, L<SSL_set_session(3)>,
Packit Service 084de1
L<SSL_CTX_set_session_cache_mode(3)>
Packit Service 084de1
L<SSL_CTX_sess_set_cache_size(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut