The last character of inconsistency in my recent commits is hereby
[openssl.git] / doc / ssl / SSL_session_reused.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_session_reused - query whether a reused session was negotiated during handshake
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_session_reused(SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 Query, whether a reused session was negotiated during the handshake.
16
17 =head1 NOTES
18
19 During the negotiation, a client can propose to reuse a session. The server
20 then looks up the session in its cache. If both client and server agree
21 on the session, it will be reused and a flag is being set that can be
22 queried by the application.
23
24 =head1 RETURN VALUES
25
26 The following return values can occur:
27
28 =over 4
29
30 =item 0
31
32 A new session was negotiated.
33
34 =item 1
35
36 A session was reused.
37
38 =back
39
40 =head1 SEE ALSO
41
42 L<ssl(3)|ssl(3)>, L<SSL_set_session(3)|SSL_set_session(3)>,
43 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>
44
45 =cut