Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_sess_number.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_NUMBER 3SSL"
58 .TH SSL_CTX_SESS_NUMBER 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_number, SSL_CTX_sess_connect, SSL_CTX_sess_connect_good, SSL_CTX_sess_connect_renegotiate, SSL_CTX_sess_accept, SSL_CTX_sess_accept_good, SSL_CTX_sess_accept_renegotiate, SSL_CTX_sess_hits, SSL_CTX_sess_cb_hits, SSL_CTX_sess_misses, SSL_CTX_sess_timeouts, SSL_CTX_sess_cache_full \- obtain session cache statistics
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& long SSL_CTX_sess_number(SSL_CTX *ctx);
71 \& long SSL_CTX_sess_connect(SSL_CTX *ctx);
72 \& long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
73 \& long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
74 \& long SSL_CTX_sess_accept(SSL_CTX *ctx);
75 \& long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
76 \& long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
77 \& long SSL_CTX_sess_hits(SSL_CTX *ctx);
78 \& long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
79 \& long SSL_CTX_sess_misses(SSL_CTX *ctx);
80 \& long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
81 \& long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\fBSSL_CTX_sess_number()\fR returns the current number of sessions in the internal
86 session cache.
87 .PP
88 \&\fBSSL_CTX_sess_connect()\fR returns the number of started SSL/TLS handshakes in
89 client mode.
90 .PP
91 \&\fBSSL_CTX_sess_connect_good()\fR returns the number of successfully established
92 SSL/TLS sessions in client mode.
93 .PP
94 \&\fBSSL_CTX_sess_connect_renegotiate()\fR returns the number of started renegotiations
95 in client mode.
96 .PP
97 \&\fBSSL_CTX_sess_accept()\fR returns the number of started SSL/TLS handshakes in
98 server mode.
99 .PP
100 \&\fBSSL_CTX_sess_accept_good()\fR returns the number of successfully established
101 SSL/TLS sessions in server mode.
102 .PP
103 \&\fBSSL_CTX_sess_accept_renegotiate()\fR returns the number of started renegotiations
104 in server mode.
105 .PP
106 \&\fBSSL_CTX_sess_hits()\fR returns the number of successfully reused sessions.
107 In client mode a session set with \fBSSL_set_session\fR\|(3)
108 successfully reused is counted as a hit. In server mode a session successfully
109 retrieved from internal or external cache is counted as a hit.
110 .PP
111 \&\fBSSL_CTX_sess_cb_hits()\fR returns the number of successfully retrieved sessions
112 from the external session cache in server mode.
113 .PP
114 \&\fBSSL_CTX_sess_misses()\fR returns the number of sessions proposed by clients
115 that were not found in the internal session cache in server mode.
116 .PP
117 \&\fBSSL_CTX_sess_timeouts()\fR returns the number of sessions proposed by clients
118 and either found in the internal or external session cache in server mode,
119 but that were invalid due to timeout. These sessions are not included in
120 the \fBSSL_CTX_sess_hits()\fR count.
121 .PP
122 \&\fBSSL_CTX_sess_cache_full()\fR returns the number of sessions that were removed
123 because the maximum session cache size was exceeded.
124 .SH "RETURN VALUES"
125 .IX Header "RETURN VALUES"
126 The functions return the values indicated in the DESCRIPTION section.
127 .SH "SEE ALSO"
128 .IX Header "SEE ALSO"
129 \&\fBssl\fR\|(7), \fBSSL_set_session\fR\|(3),
130 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3)
131 \&\fBSSL_CTX_sess_set_cache_size\fR\|(3)
132 .SH COPYRIGHT
133 .IX Header "COPYRIGHT"
134 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
135 .PP
136 Licensed under the Apache License 2.0 (the "License"). You may not use
137 this file except in compliance with the License. You can obtain a copy
138 in the file LICENSE in the source distribution or at
139 <https://www.openssl.org/source/license.html>.