openssl-cmake/doc/man3/SSL_CTX_flush_sessions.pod

58 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

2018-09-04 21:04:43 +02:00
=pod
=head1 NAME
2018-10-18 12:10:39 +02:00
SSL_CTX_flush_sessions - remove expired sessions
2018-09-04 21:04:43 +02:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
=head1 DESCRIPTION
SSL_CTX_flush_sessions() causes a run through the session cache of
B<ctx> to remove sessions expired at time B<tm>.
=head1 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
2018-10-18 12:10:39 +02:00
automatically whenever 255 new sessions were established (see
2018-09-04 21:04:43 +02:00
L<SSL_CTX_set_session_cache_mode(3)>)
or manually by calling SSL_CTX_flush_sessions().
The parameter B<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
L<SSL_CTX_sess_set_get_cb(3)>).
2018-10-18 12:10:39 +02:00
=head1 RETURN VALUES
SSL_CTX_flush_sessions() does not return a value.
2018-09-04 21:04:43 +02:00
=head1 SEE ALSO
2018-10-18 12:10:39 +02:00
L<ssl(7)>,
2018-09-04 21:04:43 +02:00
L<SSL_CTX_set_session_cache_mode(3)>,
L<SSL_CTX_set_timeout(3)>,
L<SSL_CTX_sess_set_get_cb(3)>
=head1 COPYRIGHT
2018-10-18 12:10:39 +02:00
Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
2018-09-04 21:04:43 +02:00
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut