Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_default_timeout.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_GET_DEFAULT_TIMEOUT 3SSL"
58 .TH SSL_GET_DEFAULT_TIMEOUT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_get_default_timeout \- get default session timeout value
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& long SSL_get_default_timeout(const SSL *ssl);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_get_default_timeout()\fR returns the default timeout value assigned to
75 SSL_SESSION objects negotiated for the protocol valid for \fBssl\fR.
76 .SH NOTES
77 .IX Header "NOTES"
78 Whenever a new session is negotiated, it is assigned a timeout value,
79 after which it will not be accepted for session reuse. If the timeout
80 value was not explicitly set using
81 \&\fBSSL_CTX_set_timeout\fR\|(3), the hardcoded default
82 timeout for the protocol will be used.
83 .PP
84 \&\fBSSL_get_default_timeout()\fR return this hardcoded value, which is 300 seconds
85 for all currently supported protocols.
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 See description.
89 .SH "SEE ALSO"
90 .IX Header "SEE ALSO"
91 \&\fBssl\fR\|(7),
92 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3),
93 \&\fBSSL_SESSION_get_time\fR\|(3),
94 \&\fBSSL_CTX_flush_sessions\fR\|(3),
95 \&\fBSSL_get_default_timeout\fR\|(3)
96 .SH COPYRIGHT
97 .IX Header "COPYRIGHT"
98 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
99 .PP
100 Licensed under the Apache License 2.0 (the "License"). You may not use
101 this file except in compliance with the License. You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 <https://www.openssl.org/source/license.html>.