Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_CTX_sess_number (3openssl)

Name

SSL_CTX_sess_number - 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, obtain session cache statistics

Synopsis

#include <openssl/ssl.h>

long SSL_CTX_sess_number(SSL_CTX *ctx);
long SSL_CTX_sess_connect(SSL_CTX *ctx);
long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
long SSL_CTX_sess_accept(SSL_CTX *ctx);
long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
long SSL_CTX_sess_hits(SSL_CTX *ctx);
long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
long SSL_CTX_sess_misses(SSL_CTX *ctx);
long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
long SSL_CTX_sess_cache_full(SSL_CTX *ctx);

Description

OpenSSL                                          SSL_CTX_sess_number(3openssl)



NAME
       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

SYNOPSIS
        #include <openssl/ssl.h>

        long SSL_CTX_sess_number(SSL_CTX *ctx);
        long SSL_CTX_sess_connect(SSL_CTX *ctx);
        long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
        long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
        long SSL_CTX_sess_accept(SSL_CTX *ctx);
        long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
        long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
        long SSL_CTX_sess_hits(SSL_CTX *ctx);
        long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
        long SSL_CTX_sess_misses(SSL_CTX *ctx);
        long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
        long SSL_CTX_sess_cache_full(SSL_CTX *ctx);

DESCRIPTION
       SSL_CTX_sess_number() returns the current number of sessions in the
       internal session cache.

       SSL_CTX_sess_connect() returns the number of started SSL/TLS handshakes
       in client mode.

       SSL_CTX_sess_connect_good() returns the number of successfully
       established SSL/TLS sessions in client mode.

       SSL_CTX_sess_connect_renegotiate() returns the number of start
       renegotiations in client mode.

       SSL_CTX_sess_accept() returns the number of started SSL/TLS handshakes
       in server mode.

       SSL_CTX_sess_accept_good() returns the number of successfully
       established SSL/TLS sessions in server mode.

       SSL_CTX_sess_accept_renegotiate() returns the number of start
       renegotiations in server mode.

       SSL_CTX_sess_hits() returns the number of successfully reused sessions.
       In client mode a session set with SSL_set_session(3) successfully
       reused is counted as a hit. In server mode a session successfully
       retrieved from internal or external cache is counted as a hit.

       SSL_CTX_sess_cb_hits() returns the number of successfully retrieved
       sessions from the external session cache in server mode.

       SSL_CTX_sess_misses() returns the number of sessions proposed by
       clients that were not found in the internal session cache in server
       mode.

       SSL_CTX_sess_timeouts() returns the number of sessions proposed by
       clients and either found in the internal or external session cache in
       server mode,
        but that were invalid due to timeout. These sessions are not included
       in the SSL_CTX_sess_hits() count.

       SSL_CTX_sess_cache_full() returns the number of sessions that were
       removed because the maximum session cache size was exceeded.

RETURN VALUES
       The functions return the values indicated in the DESCRIPTION section.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       ssl(3), SSL_set_session(3), SSL_CTX_set_session_cache_mode(3)
       SSL_CTX_sess_set_cache_size(3)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03
                                                 SSL_CTX_sess_number(3openssl)