Correct example.
[openssl.git] / doc / ssl / SSL_CTX_flush_sessions.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_flush_sessions, SSL_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  void SSL_flush_sessions(SSL_CTX *ctx, long tm);
13
14 =head1 DESCRIPTION
15
16 SSL_CTX_flush_sessions() causes a run through the session cache of
17 B<ctx> to remove sessions expired at time B<tm>.
18
19 SSL_flush_sessions() is a synonym for SSL_CTX_flush_sessions().
20
21 =head1 NOTES
22
23 If enabled, the internal session cache will collect all sessions established
24 up to the specified maximum number (see SSL_CTX_sess_set_cache_size()).
25 As sessions will not be reused ones they are expired, they should be
26 removed from the cache to save resources. This can either be done
27  automatically whenever 255 new sessions were established (see
28 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>)
29 or manually by calling SSL_CTX_flush_sessions(). 
30
31 The parameter B<tm> specifies the time which should be used for the
32 expiration test, in most cases the actual time given by time(0)
33 will be used.
34
35 SSL_CTX_flush_sessions() will only check sessions stored in the internal
36 cache. When a session is found and removed, the remove_session_cb is however
37 called to synchronize with the external cache (see
38 L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>).
39
40 =head1 RETURN VALUES
41
42 =head1 SEE ALSO
43
44 L<ssl(3)|ssl(3)>,
45 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
46 L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>,
47 L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>
48
49 =cut