secure/lib/libssl/man/SSL_CTX_sess_number.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   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.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  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 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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 "2006-09-06" "0.9.8c" "OpenSSL"
 133 .SH "NAME"
 134 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
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/ssl.h>
 139 .Ve
 140 .PP
 141 .Vb 12
 142 \& long SSL_CTX_sess_number(SSL_CTX *ctx);
 143 \& long SSL_CTX_sess_connect(SSL_CTX *ctx);
 144 \& long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
 145 \& long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
 146 \& long SSL_CTX_sess_accept(SSL_CTX *ctx);
 147 \& long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
 148 \& long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
 149 \& long SSL_CTX_sess_hits(SSL_CTX *ctx);
 150 \& long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
 151 \& long SSL_CTX_sess_misses(SSL_CTX *ctx);
 152 \& long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
 153 \& long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fISSL_CTX_sess_number()\fR returns the current number of sessions in the internal
 158 session cache.
 159 .PP
 160 \&\fISSL_CTX_sess_connect()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 161 client mode.
 162 .PP
 163 \&\fISSL_CTX_sess_connect_good()\fR returns the number of successfully established
 164 \&\s-1SSL/TLS\s0 sessions in client mode.
 165 .PP
 166 \&\fISSL_CTX_sess_connect_renegotiate()\fR returns the number of start renegotiations
 167 in client mode.
 168 .PP
 169 \&\fISSL_CTX_sess_accept()\fR returns the number of started \s-1SSL/TLS\s0 handshakes in
 170 server mode.
 171 .PP
 172 \&\fISSL_CTX_sess_accept_good()\fR returns the number of successfully established
 173 \&\s-1SSL/TLS\s0 sessions in server mode.
 174 .PP
 175 \&\fISSL_CTX_sess_accept_renegotiate()\fR returns the number of start renegotiations
 176 in server mode.
 177 .PP
 178 \&\fISSL_CTX_sess_hits()\fR returns the number of successfully reused sessions.
 179 In client mode a session set with \fISSL_set_session\fR\|(3)
 180 successfully reused is counted as a hit. In server mode a session successfully
 181 retrieved from internal or external cache is counted as a hit.
 182 .PP
 183 \&\fISSL_CTX_sess_cb_hits()\fR returns the number of successfully retrieved sessions
 184 from the external session cache in server mode.
 185 .PP
 186 \&\fISSL_CTX_sess_misses()\fR returns the number of sessions proposed by clients
 187 that were not found in the internal session cache in server mode.
 188 .PP
 189 \&\fISSL_CTX_sess_timeouts()\fR returns the number of sessions proposed by clients
 190 and either found in the internal or external session cache in server mode,
 191  but that were invalid due to timeout. These sessions are not included in
 192 the \fISSL_CTX_sess_hits()\fR count.
 193 .PP
 194 \&\fISSL_CTX_sess_cache_full()\fR returns the number of sessions that were removed
 195 because the maximum session cache size was exceeded.
 196 .SH "RETURN VALUES"
 197 .IX Header "RETURN VALUES"
 198 The functions return the values indicated in the \s-1DESCRIPTION\s0 section.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fIssl\fR\|(3), \fISSL_set_session\fR\|(3),
 202 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)
 203 \&\fISSL_CTX_sess_set_cache_size\fR\|(3)