Document session caching, first step.
[openssl.git] / doc / ssl / SSL_set_session.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_set_session - set a TLS/SSL session to be used during TLS/SSL connect
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_set_session(SSL *ssl, SSL_SESSION *session);
12
13 =head1 DESCRIPTION
14
15 SSL_set_session() sets B<session> to be used when the TLS/SSL connection
16 is to be established. SSL_set_session() is only useful for TLS/SSL clients.
17 When the session is set, the reference count of B<session> is incremented
18 by 1. If the session is not reused, the reference count is decremented
19 again during SSL_connect().
20
21 If there is already a session set inside B<ssl> (because it was set with
22 SSL_set_session() before or because the same B<ssl> was already used for
23 a connection), SSL_SESSION_free() will be called for that session.
24
25 =head1 RETURN VALUES
26
27 The following return values can occur:
28
29 =over 4
30
31 =item 0
32
33 The operation failed; check the error stack to find out the reason.
34
35 =item 1
36
37 The operation succeeded.
38
39 =back
40
41 =head1 SEE ALSO
42
43 L<ssl(3)|ssl(3)>, L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>,
44 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>
45
46 =cut