xref: /freebsd/crypto/openssl/doc/man3/SSL_get_default_timeout.pod (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1=pod
2
3=head1 NAME
4
5SSL_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
15SSL_get_default_timeout() returns the default timeout value assigned to
16SSL_SESSION objects negotiated for the protocol valid for B<ssl>.
17
18=head1 NOTES
19
20Whenever a new session is negotiated, it is assigned a timeout value,
21after which it will not be accepted for session reuse. If the timeout
22value was not explicitly set using
23L<SSL_CTX_set_timeout(3)>, the hardcoded default
24timeout for the protocol will be used.
25
26SSL_get_default_timeout() return this hardcoded value, which is 300 seconds
27for all currently supported protocols.
28
29=head1 RETURN VALUES
30
31See description.
32
33=head1 SEE ALSO
34
35L<ssl(7)>,
36L<SSL_CTX_set_session_cache_mode(3)>,
37L<SSL_SESSION_get_time(3)>,
38L<SSL_CTX_flush_sessions(3)>,
39L<SSL_get_default_timeout(3)>
40
41=head1 COPYRIGHT
42
43Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
44
45Licensed under the OpenSSL license (the "License").  You may not use
46this file except in compliance with the License.  You can obtain a copy
47in the file LICENSE in the source distribution or at
48L<https://www.openssl.org/source/license.html>.
49
50=cut
51