secure/lib/libssl/man/SSL_CTX_sess_number.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   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 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "SSL_CTX_sess_number 3"
 127 .TH SSL_CTX_sess_number 3 "2011-02-08" "1.0.0d" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 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
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \& #include <openssl/ssl.h>
 138 \&
 139 \& long SSL_CTX_sess_number(SSL_CTX *ctx);
 140 \& long SSL_CTX_sess_connect(SSL_CTX *ctx);
 141 \& long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
 142 \& long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
 143 \& long SSL_CTX_sess_accept(SSL_CTX *ctx);
 144 \& long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
 145 \& long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
 146 \& long SSL_CTX_sess_hits(SSL_CTX *ctx);
 147 \& long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
 148 \& long SSL_CTX_sess_misses(SSL_CTX *ctx);
 149 \& long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
 150 \& long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fISSL_CTX_sess_number()\fR returns the current number of sessions in the internal
 155 session cache.
 156 .PP
 157 \&\fISSL_CTX_sess_connect()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 158 client mode.
 159 .PP
 160 \&\fISSL_CTX_sess_connect_good()\fR returns the number of successfully established
 161 \&\s-1SSL/TLS\s0 sessions in client mode.
 162 .PP
 163 \&\fISSL_CTX_sess_connect_renegotiate()\fR returns the number of start renegotiations
 164 in client mode.
 165 .PP
 166 \&\fISSL_CTX_sess_accept()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 167 server mode.
 168 .PP
 169 \&\fISSL_CTX_sess_accept_good()\fR returns the number of successfully established
 170 \&\s-1SSL/TLS\s0 sessions in server mode.
 171 .PP
 172 \&\fISSL_CTX_sess_accept_renegotiate()\fR returns the number of start renegotiations
 173 in server mode.
 174 .PP
 175 \&\fISSL_CTX_sess_hits()\fR returns the number of successfully reused sessions.
 176 In client mode a session set with \fISSL_set_session\fR\|(3)
 177 successfully reused is counted as a hit. In server mode a session successfully
 178 retrieved from internal or external cache is counted as a hit.
 179 .PP
 180 \&\fISSL_CTX_sess_cb_hits()\fR returns the number of successfully retrieved sessions
 181 from the external session cache in server mode.
 182 .PP
 183 \&\fISSL_CTX_sess_misses()\fR returns the number of sessions proposed by clients
 184 that were not found in the internal session cache in server mode.
 185 .PP
 186 \&\fISSL_CTX_sess_timeouts()\fR returns the number of sessions proposed by clients
 187 and either found in the internal or external session cache in server mode,
 188  but that were invalid due to timeout. These sessions are not included in
 189 the \fISSL_CTX_sess_hits()\fR count.
 190 .PP
 191 \&\fISSL_CTX_sess_cache_full()\fR returns the number of sessions that were removed
 192 because the maximum session cache size was exceeded.
 193 .SH "RETURN VALUES"
 194 .IX Header "RETURN VALUES"
 195 The functions return the values indicated in the \s-1DESCRIPTION\s0 section.
 196 .SH "SEE ALSO"
 197 .IX Header "SEE ALSO"
 198 \&\fIssl\fR\|(3), \fISSL_set_session\fR\|(3),
 199 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)
 200 \&\fISSL_CTX_sess_set_cache_size\fR\|(3)