Small script to re-encode files that need it to UTF-8
[openssl.git] / doc / ssl / SSL_get_default_timeout.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_default_timeout - get default session timeout value
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  long SSL_get_default_timeout(const SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 SSL_get_default_timeout() returns the default timeout value assigned to
16 SSL_SESSION objects negotiated for the protocol valid for B<ssl>.
17
18 =head1 NOTES
19
20 Whenever a new session is negotiated, it is assigned a timeout value,
21 after which it will not be accepted for session reuse. If the timeout
22 value was not explicitly set using
23 L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>, the hardcoded default
24 timeout for the protocol will be used.
25
26 SSL_get_default_timeout() return this hardcoded value, which is 300 seconds
27 for all currently supported protocols.
28
29 =head1 RETURN VALUES
30
31 See description.
32
33 =head1 SEE ALSO
34
35 L<ssl(3)|ssl(3)>,
36 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
37 L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,
38 L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,
39 L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>
40
41 =cut