secure/lib/libcrypto/man/SSL_CTX_sess_number.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_SESS_NUMBER 3"
 132 .TH SSL_CTX_SESS_NUMBER 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& long SSL_CTX_sess_number(SSL_CTX *ctx);
 145 \& long SSL_CTX_sess_connect(SSL_CTX *ctx);
 146 \& long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
 147 \& long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
 148 \& long SSL_CTX_sess_accept(SSL_CTX *ctx);
 149 \& long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
 150 \& long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
 151 \& long SSL_CTX_sess_hits(SSL_CTX *ctx);
 152 \& long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
 153 \& long SSL_CTX_sess_misses(SSL_CTX *ctx);
 154 \& long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
 155 \& long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fISSL_CTX_sess_number()\fR returns the current number of sessions in the internal
 160 session cache.
 161 .PP
 162 \&\fISSL_CTX_sess_connect()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 163 client mode.
 164 .PP
 165 \&\fISSL_CTX_sess_connect_good()\fR returns the number of successfully established
 166 \&\s-1SSL/TLS\s0 sessions in client mode.
 167 .PP
 168 \&\fISSL_CTX_sess_connect_renegotiate()\fR returns the number of started renegotiations
 169 in client mode.
 170 .PP
 171 \&\fISSL_CTX_sess_accept()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 172 server mode.
 173 .PP
 174 \&\fISSL_CTX_sess_accept_good()\fR returns the number of successfully established
 175 \&\s-1SSL/TLS\s0 sessions in server mode.
 176 .PP
 177 \&\fISSL_CTX_sess_accept_renegotiate()\fR returns the number of started renegotiations
 178 in server mode.
 179 .PP
 180 \&\fISSL_CTX_sess_hits()\fR returns the number of successfully reused sessions.
 181 In client mode a session set with \fISSL_set_session\fR\|(3)
 182 successfully reused is counted as a hit. In server mode a session successfully
 183 retrieved from internal or external cache is counted as a hit.
 184 .PP
 185 \&\fISSL_CTX_sess_cb_hits()\fR returns the number of successfully retrieved sessions
 186 from the external session cache in server mode.
 187 .PP
 188 \&\fISSL_CTX_sess_misses()\fR returns the number of sessions proposed by clients
 189 that were not found in the internal session cache in server mode.
 190 .PP
 191 \&\fISSL_CTX_sess_timeouts()\fR returns the number of sessions proposed by clients
 192 and either found in the internal or external session cache in server mode,
 193  but that were invalid due to timeout. These sessions are not included in
 194 the \fISSL_CTX_sess_hits()\fR count.
 195 .PP
 196 \&\fISSL_CTX_sess_cache_full()\fR returns the number of sessions that were removed
 197 because the maximum session cache size was exceeded.
 198 .SH "RETURN VALUES"
 199 .IX Header "RETURN VALUES"
 200 The functions return the values indicated in the \s-1DESCRIPTION\s0 section.
 201 .SH "SEE ALSO"
 202 .IX Header "SEE ALSO"
 203 \&\fIssl\fR\|(7), \fISSL_set_session\fR\|(3),
 204 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)
 205 \&\fISSL_CTX_sess_set_cache_size\fR\|(3)
 206 .SH "COPYRIGHT"
 207 .IX Header "COPYRIGHT"
 208 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 209 .PP
 210 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 211 this file except in compliance with the License.  You can obtain a copy
 212 in the file \s-1LICENSE\s0 in the source distribution or at
 213 <https://www.openssl.org/source/license.html>.