Blame doc/man3/SSL_get_default_timeout.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
SSL_get_default_timeout - get default session timeout value
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 long SSL_get_default_timeout(const SSL *ssl);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL_get_default_timeout() returns the default timeout value assigned to
Packit Service 084de1
SSL_SESSION objects negotiated for the protocol valid for B<ssl>.
Packit Service 084de1
Packit Service 084de1
=head1 NOTES
Packit Service 084de1
Packit Service 084de1
Whenever a new session is negotiated, it is assigned a timeout value,
Packit Service 084de1
after which it will not be accepted for session reuse. If the timeout
Packit Service 084de1
value was not explicitly set using
Packit Service 084de1
L<SSL_CTX_set_timeout(3)>, the hardcoded default
Packit Service 084de1
timeout for the protocol will be used.
Packit Service 084de1
Packit Service 084de1
SSL_get_default_timeout() return this hardcoded value, which is 300 seconds
Packit Service 084de1
for all currently supported protocols.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
See description.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<ssl(7)>,
Packit Service 084de1
L<SSL_CTX_set_session_cache_mode(3)>,
Packit Service 084de1
L<SSL_SESSION_get_time(3)>,
Packit Service 084de1
L<SSL_CTX_flush_sessions(3)>,
Packit Service 084de1
L<SSL_get_default_timeout(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut