secure/lib/libssl/man/SSL_CTX_sess_number.3

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