xref: /freebsd/crypto/openssl/doc/man3/SSL_CTX_sess_number.pod (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1=pod
2
3=head1 NAME
4
5SSL_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
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 long SSL_CTX_sess_number(SSL_CTX *ctx);
12 long SSL_CTX_sess_connect(SSL_CTX *ctx);
13 long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
14 long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
15 long SSL_CTX_sess_accept(SSL_CTX *ctx);
16 long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
17 long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
18 long SSL_CTX_sess_hits(SSL_CTX *ctx);
19 long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
20 long SSL_CTX_sess_misses(SSL_CTX *ctx);
21 long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
22 long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
23
24=head1 DESCRIPTION
25
26SSL_CTX_sess_number() returns the current number of sessions in the internal
27session cache.
28
29SSL_CTX_sess_connect() returns the number of started SSL/TLS handshakes in
30client mode.
31
32SSL_CTX_sess_connect_good() returns the number of successfully established
33SSL/TLS sessions in client mode.
34
35SSL_CTX_sess_connect_renegotiate() returns the number of started renegotiations
36in client mode.
37
38SSL_CTX_sess_accept() returns the number of started SSL/TLS handshakes in
39server mode.
40
41SSL_CTX_sess_accept_good() returns the number of successfully established
42SSL/TLS sessions in server mode.
43
44SSL_CTX_sess_accept_renegotiate() returns the number of started renegotiations
45in server mode.
46
47SSL_CTX_sess_hits() returns the number of successfully reused sessions.
48In client mode a session set with L<SSL_set_session(3)>
49successfully reused is counted as a hit. In server mode a session successfully
50retrieved from internal or external cache is counted as a hit.
51
52SSL_CTX_sess_cb_hits() returns the number of successfully retrieved sessions
53from the external session cache in server mode.
54
55SSL_CTX_sess_misses() returns the number of sessions proposed by clients
56that were not found in the internal session cache in server mode.
57
58SSL_CTX_sess_timeouts() returns the number of sessions proposed by clients
59and either found in the internal or external session cache in server mode,
60 but that were invalid due to timeout. These sessions are not included in
61the SSL_CTX_sess_hits() count.
62
63SSL_CTX_sess_cache_full() returns the number of sessions that were removed
64because the maximum session cache size was exceeded.
65
66=head1 RETURN VALUES
67
68The functions return the values indicated in the DESCRIPTION section.
69
70=head1 SEE ALSO
71
72L<ssl(7)>, L<SSL_set_session(3)>,
73L<SSL_CTX_set_session_cache_mode(3)>
74L<SSL_CTX_sess_set_cache_size(3)>
75
76=head1 COPYRIGHT
77
78Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
79
80Licensed under the OpenSSL license (the "License").  You may not use
81this file except in compliance with the License.  You can obtain a copy
82in the file LICENSE in the source distribution or at
83L<https://www.openssl.org/source/license.html>.
84
85=cut
86