projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 52129c0b LJ |
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 | ||
| c3e64028 | 11 | long SSL_get_default_timeout(const SSL *ssl); |
| 52129c0b LJ |
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 | |
| 9b86974e | 23 | L<SSL_CTX_set_timeout(3)>, the hardcoded default |
| 52129c0b LJ |
24 | timeout for the protocol will be used. |
| 25 | ||
| 26 | SSL_get_default_timeout() return this hardcoded value, which is 300 seconds | |
| 45f55f6a | 27 | for all currently supported protocols. |
| 52129c0b LJ |
28 | |
| 29 | =head1 RETURN VALUES | |
| 30 | ||
| 31 | See description. | |
| 32 | ||
| 33 | =head1 SEE ALSO | |
| 34 | ||
| b97fdb57 | 35 | L<ssl(7)>, |
| 9b86974e RS |
36 | L<SSL_CTX_set_session_cache_mode(3)>, |
| 37 | L<SSL_SESSION_get_time(3)>, | |
| 38 | L<SSL_CTX_flush_sessions(3)>, | |
| 39 | L<SSL_get_default_timeout(3)> | |
| 52129c0b | 40 | |
| e2f92610 RS |
41 | =head1 COPYRIGHT |
| 42 | ||
| 43 | Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 44 | ||
| 4746f25a | 45 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| e2f92610 RS |
46 | this file except in compliance with the License. You can obtain a copy |
| 47 | in the file LICENSE in the source distribution or at | |
| 48 | L<https://www.openssl.org/source/license.html>. | |
| 49 | ||
| 50 | =cut |