SSL_get_session.pod revision 68651 
1=pod
2
3=head1 NAME
4
5SSL_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
17SSL_get_session() returns a pointer to the B<SSL_SESSION> actually used in
18B<ssl>. The reference count of the B<SSL_SESSION> is not incremented, so
19that the pointer can become invalid when the B<ssl> is freed and
20SSL_SESSION_free() is implicitly called.
21
22SSL_get0_session() is the same as SSL_get_session().
23
24SSL_get1_session() is the same as SSL_get_session(), but the reference
25count of the B<SSL_SESSION> is incremented by one.
26
27=head1 RETURN VALUES
28
29The following return values can occur:
30
31=over 4
32
33=item NULL
34
35There is no session available in B<ssl>.
36
37=item Pointer to an SSL
38
39The return value points to the data of an SSL session.
40
41=back
42
43=head1 SEE ALSO
44
45L<ssl(3)|ssl(3)>, L<SSL_free(3)|SSL_free(3)>,
46L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
47
48=cut
49