Remove doc of non-existent functions
[openssl.git] / doc / man3 / SSL_CTX_flush_sessions.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_flush_sessions - remove expired sessions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
12
13 =head1 DESCRIPTION
14
15 SSL_CTX_flush_sessions() causes a run through the session cache of
16 B<ctx> to remove sessions expired at time B<tm>.
17
18 =head1 NOTES
19
20 If enabled, the internal session cache will collect all sessions established
21 up to the specified maximum number (see SSL_CTX_sess_set_cache_size()).
22 As sessions will not be reused ones they are expired, they should be
23 removed from the cache to save resources. This can either be done
24 automatically whenever 255 new sessions were established (see
25 L<SSL_CTX_set_session_cache_mode(3)>)
26 or manually by calling SSL_CTX_flush_sessions().
27
28 The parameter B<tm> specifies the time which should be used for the
29 expiration test, in most cases the actual time given by time(0)
30 will be used.
31
32 SSL_CTX_flush_sessions() will only check sessions stored in the internal
33 cache. When a session is found and removed, the remove_session_cb is however
34 called to synchronize with the external cache (see
35 L<SSL_CTX_sess_set_get_cb(3)>).
36
37 =head1 SEE ALSO
38
39 L<ssl(7)>,
40 L<SSL_CTX_set_session_cache_mode(3)>,
41 L<SSL_CTX_set_timeout(3)>,
42 L<SSL_CTX_sess_set_get_cb(3)>
43
44 =head1 COPYRIGHT
45
46 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
47
48 Licensed under the OpenSSL license (the "License").  You may not use
49 this file except in compliance with the License.  You can obtain a copy
50 in the file LICENSE in the source distribution or at
51 L<https://www.openssl.org/source/license.html>.
52
53 =cut