Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_sess_set_cache_size.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_SESS_SET_CACHE_SIZE 3SSL"
58 .TH SSL_CTX_SESS_SET_CACHE_SIZE 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_sess_set_cache_size, SSL_CTX_sess_get_cache_size \- manipulate session cache size
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx, long t);
71 \& long SSL_CTX_sess_get_cache_size(SSL_CTX *ctx);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBSSL_CTX_sess_set_cache_size()\fR sets the size of the internal session cache
76 of context \fBctx\fR to \fBt\fR.
77 This value is a hint and not an absolute; see the notes below.
78 .PP
79 \&\fBSSL_CTX_sess_get_cache_size()\fR returns the currently valid session cache size.
80 .SH NOTES
81 .IX Header "NOTES"
82 The internal session cache size is SSL_SESSION_CACHE_MAX_SIZE_DEFAULT,
83 currently 1024*20, so that up to 20000 sessions can be held. This size
84 can be modified using the \fBSSL_CTX_sess_set_cache_size()\fR call. A special
85 case is the size 0, which is used for unlimited size.
86 .PP
87 If adding the session makes the cache exceed its size, then unused
88 sessions are dropped from the end of the cache.
89 Cache space may also be reclaimed by calling
90 \&\fBSSL_CTX_flush_sessions\fR\|(3) to remove
91 expired sessions.
92 .PP
93 If the size of the session cache is reduced and more sessions are already
94 in the session cache, old session will be removed at the next time a
95 session shall be added. This removal is not synchronized with the
96 expiration of sessions.
97 .SH "RETURN VALUES"
98 .IX Header "RETURN VALUES"
99 \&\fBSSL_CTX_sess_set_cache_size()\fR returns the previously valid size.
100 .PP
101 \&\fBSSL_CTX_sess_get_cache_size()\fR returns the currently valid size.
102 .SH "SEE ALSO"
103 .IX Header "SEE ALSO"
104 \&\fBssl\fR\|(7),
105 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3),
106 \&\fBSSL_CTX_sess_number\fR\|(3),
107 \&\fBSSL_CTX_flush_sessions\fR\|(3)
108 .SH COPYRIGHT
109 .IX Header "COPYRIGHT"
110 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
111 .PP
112 Licensed under the Apache License 2.0 (the "License"). You may not use
113 this file except in compliance with the License. You can obtain a copy
114 in the file LICENSE in the source distribution or at
115 <https://www.openssl.org/source/license.html>.