Make clear, that using the compression layer is currently not recommended.
[openssl.git] / doc / ssl / SSL_get_session.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_session - retrieve TLS/SSL session data
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  SSL_SESSION *SSL_get_session(SSL *ssl);
12  SSL_SESSION *SSL_get0_session(SSL *ssl);
13  SSL_SESSION *SSL_get1_session(SSL *ssl);
14
15 =head1 DESCRIPTION
16
17 SSL_get_session() returns a pointer to the B<SSL_SESSION> actually used in
18 B<ssl>. The reference count of the B<SSL_SESSION> is not incremented, so
19 that the pointer can become invalid by other operations.
20
21 SSL_get0_session() is the same as SSL_get_session().
22
23 SSL_get1_session() is the same as SSL_get_session(), but the reference
24 count of the B<SSL_SESSION> is incremented by one.
25
26 =head1 NOTES
27
28 The ssl session contains all information required to re-establish the
29 connection without a new handshake.
30
31 SSL_get0_session() returns a pointer to the actual session. As the
32 reference counter is not incremented, the pointer is only valid while
33 the connection is in use. If L<SSL_clear(3)|SSL_clear(3)> or
34 L<SSL_free(3)|SSL_free(3)> is called, the session may be removed completely
35 (if considered bad), and the pointer obtained will become invalid. Even
36 if the session is valid, it can be removed at any time due to timeout
37 during L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>.
38
39 If the data is to be kept, SSL_get1_session() will increment the reference
40 count and the session will stay in memory until explicitly freed with
41 L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>, regardless of its state.
42
43 =head1 RETURN VALUES
44
45 The following return values can occur:
46
47 =over 4
48
49 =item NULL
50
51 There is no session available in B<ssl>.
52
53 =item Pointer to an SSL
54
55 The return value points to the data of an SSL session.
56
57 =back
58
59 =head1 SEE ALSO
60
61 L<ssl(3)|ssl(3)>, L<SSL_free(3)|SSL_free(3)>,
62 L<SSL_clear(3)|SSL_clear(3)>,
63 L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
64
65 =cut