Blame doc/man3/SSL_CTX_flush_sessions.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
SSL_CTX_flush_sessions - remove expired sessions
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL_CTX_flush_sessions() causes a run through the session cache of
Packit Service 084de1
B<ctx> to remove sessions expired at time B<tm>.
Packit Service 084de1
Packit Service 084de1
=head1 NOTES
Packit Service 084de1
Packit Service 084de1
If enabled, the internal session cache will collect all sessions established
Packit Service 084de1
up to the specified maximum number (see SSL_CTX_sess_set_cache_size()).
Packit Service 084de1
As sessions will not be reused ones they are expired, they should be
Packit Service 084de1
removed from the cache to save resources. This can either be done
Packit Service 084de1
automatically whenever 255 new sessions were established (see
Packit Service 084de1
L<SSL_CTX_set_session_cache_mode(3)>)
Packit Service 084de1
or manually by calling SSL_CTX_flush_sessions().
Packit Service 084de1
Packit Service 084de1
The parameter B<tm> specifies the time which should be used for the
Packit Service 084de1
expiration test, in most cases the actual time given by time(0)
Packit Service 084de1
will be used.
Packit Service 084de1
Packit Service 084de1
SSL_CTX_flush_sessions() will only check sessions stored in the internal
Packit Service 084de1
cache. When a session is found and removed, the remove_session_cb is however
Packit Service 084de1
called to synchronize with the external cache (see
Packit Service 084de1
L<SSL_CTX_sess_set_get_cb(3)>).
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
SSL_CTX_flush_sessions() does not return a value.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<ssl(7)>,
Packit Service 084de1
L<SSL_CTX_set_session_cache_mode(3)>,
Packit Service 084de1
L<SSL_CTX_set_timeout(3)>,
Packit Service 084de1
L<SSL_CTX_sess_set_get_cb(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2001-2018 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