xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/SSL_get_default_timeout.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: SSL_get_default_timeout.3,v 1.25 2024/09/08 13:08:34 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_get_default_timeout 3"
SSL_get_default_timeout 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
SSL_get_default_timeout - get default session timeout value
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& long SSL_get_default_timeout(const SSL *ssl); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_get_default_timeout() returns the default timeout value assigned to SSL_SESSION objects negotiated for the protocol valid for ssl.
NOTES
Header "NOTES" Whenever a new session is negotiated, it is assigned a timeout value, after which it will not be accepted for session reuse. If the timeout value was not explicitly set using \fBSSL_CTX_set_timeout\|(3), the hardcoded default timeout for the protocol will be used.

\fBSSL_get_default_timeout() return this hardcoded value, which is 300 seconds for all currently supported protocols.

"RETURN VALUES"
Header "RETURN VALUES" See description.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), \fBSSL_CTX_set_session_cache_mode\|(3), \fBSSL_SESSION_get_time\|(3), \fBSSL_CTX_flush_sessions\|(3), \fBSSL_get_default_timeout\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.