xref: /onnv-gate/usr/src/common/openssl/doc/ssl/SSL_session_reused.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948SSL_session_reused - query whether a reused session was negotiated during handshake
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/ssl.h>
10*2175Sjp161948
11*2175Sjp161948 int SSL_session_reused(SSL *ssl);
12*2175Sjp161948
13*2175Sjp161948=head1 DESCRIPTION
14*2175Sjp161948
15*2175Sjp161948Query, whether a reused session was negotiated during the handshake.
16*2175Sjp161948
17*2175Sjp161948=head1 NOTES
18*2175Sjp161948
19*2175Sjp161948During the negotiation, a client can propose to reuse a session. The server
20*2175Sjp161948then looks up the session in its cache. If both client and server agree
21*2175Sjp161948on the session, it will be reused and a flag is being set that can be
22*2175Sjp161948queried by the application.
23*2175Sjp161948
24*2175Sjp161948=head1 RETURN VALUES
25*2175Sjp161948
26*2175Sjp161948The following return values can occur:
27*2175Sjp161948
28*2175Sjp161948=over 4
29*2175Sjp161948
30*2175Sjp161948=item 0
31*2175Sjp161948
32*2175Sjp161948A new session was negotiated.
33*2175Sjp161948
34*2175Sjp161948=item 1
35*2175Sjp161948
36*2175Sjp161948A session was reused.
37*2175Sjp161948
38*2175Sjp161948=back
39*2175Sjp161948
40*2175Sjp161948=head1 SEE ALSO
41*2175Sjp161948
42*2175Sjp161948L<ssl(3)|ssl(3)>, L<SSL_set_session(3)|SSL_set_session(3)>,
43*2175Sjp161948L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>
44*2175Sjp161948
45*2175Sjp161948=cut
46