Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_CTX_flush_sessions (3openssl)

Name

SSL_CTX_flush_sessions - remove expired sessions

Synopsis

#include <openssl/ssl.h>

void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
void SSL_flush_sessions(SSL_CTX *ctx, long tm);

Description

OpenSSL                                       SSL_CTX_flush_sessions(3openssl)



NAME
       SSL_CTX_flush_sessions, SSL_flush_sessions - remove expired sessions

SYNOPSIS
        #include <openssl/ssl.h>

        void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
        void SSL_flush_sessions(SSL_CTX *ctx, long tm);

DESCRIPTION
       SSL_CTX_flush_sessions() causes a run through the session cache of ctx
       to remove sessions expired at time tm.

       SSL_flush_sessions() is a synonym for SSL_CTX_flush_sessions().


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


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

NOTES
       If enabled, the internal session cache will collect all sessions
       established up to the specified maximum number (see
       SSL_CTX_sess_set_cache_size()).  As sessions will not be reused ones
       they are expired, they should be removed from the cache to save
       resources. This can either be done
        automatically whenever 255 new sessions were established (see
       SSL_CTX_set_session_cache_mode(3)) or manually by calling
       SSL_CTX_flush_sessions().

       The parameter tm specifies the time which should be used for the
       expiration test, in most cases the actual time given by time(0) will be
       used.

       SSL_CTX_flush_sessions() will only check sessions stored in the
       internal cache. When a session is found and removed, the
       remove_session_cb is however called to synchronize with the external
       cache (see SSL_CTX_sess_set_get_cb(3)).

       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/.

RETURN VALUES
SEE ALSO
       ssl(3), SSL_CTX_set_session_cache_mode(3), SSL_CTX_set_timeout(3),
       SSL_CTX_sess_set_get_cb(3)




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