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