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