Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_flush_sessions.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_CTX_FLUSH_SESSIONS 3SSL"
58 .TH SSL_CTX_FLUSH_SESSIONS 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_CTX_flush_sessions_ex, SSL_CTX_flush_sessions \- remove expired sessions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& void SSL_CTX_flush_sessions_ex(SSL_CTX *ctx, time_t tm);
71 .Ve
72 .PP
73 The following functions have been deprecated since OpenSSL 3.4, and can be
74 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
75 see \fBopenssl_user_macros\fR\|(7):
76 .PP
77 .Vb 1
78 \& void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBSSL_CTX_flush_sessions_ex()\fR causes a run through the session cache of
83 \&\fBctx\fR to remove sessions expired at time \fBtm\fR.
84 .PP
85 \&\fBSSL_CTX_flush_sessions()\fR is an older variant of the function that is not
86 Y2038 safe due to usage of long datatype instead of time_t.
87 .SH NOTES
88 .IX Header "NOTES"
89 If enabled, the internal session cache will collect all sessions established
90 up to the specified maximum number (see \fBSSL_CTX_sess_set_cache_size()\fR).
91 As sessions will not be reused ones they are expired, they should be
92 removed from the cache to save resources. This can either be done
93 automatically whenever 255 new sessions were established (see
94 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3))
95 or manually by calling \fBSSL_CTX_flush_sessions_ex()\fR.
96 .PP
97 The parameter \fBtm\fR specifies the time which should be used for the
98 expiration test, in most cases the actual time given by \fBtime\fR\|(0)
99 will be used.
100 .PP
101 \&\fBSSL_CTX_flush_sessions_ex()\fR will only check sessions stored in the internal
102 cache. When a session is found and removed, the remove_session_cb is however
103 called to synchronize with the external cache (see
104 \&\fBSSL_CTX_sess_set_get_cb\fR\|(3)).
105 .SH "RETURN VALUES"
106 .IX Header "RETURN VALUES"
107 \&\fBSSL_CTX_flush_sessions_ex()\fR does not return a value.
108 .SH "SEE ALSO"
109 .IX Header "SEE ALSO"
110 \&\fBssl\fR\|(7),
111 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3),
112 \&\fBSSL_CTX_set_timeout\fR\|(3),
113 \&\fBSSL_CTX_sess_set_get_cb\fR\|(3)
114 .SH HISTORY
115 .IX Header "HISTORY"
116 \&\fBSSL_CTX_flush_sessions_ex()\fR was added in OpenSSL 3.4.
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright 2001\-2024 The OpenSSL Project Authors. All Rights Reserved.
120 .PP
121 Licensed under the Apache License 2.0 (the "License"). You may not use
122 this file except in compliance with the License. You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 <https://www.openssl.org/source/license.html>.