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(). Whether the session was reused can be queried
  20 with the L<SSL_session_reused(3)|SSL_session_reused(3)> call.
  21
  22 If there is already a session set inside B<ssl> (because it was set with
  23 SSL_set_session() before or because the same B<ssl> was already used for
  24 a connection), SSL_SESSION_free() will be called for that session.
  25
  26 =head1 RETURN VALUES
  27
  28 The following return values can occur:
  29
  30 =over 4
  31
  32 =item 0
  33
  34 The operation failed; check the error stack to find out the reason.
  35
  36 =item 1
  37
  38 The operation succeeded.
  39
  40 =back
  41
  42 =head1 SEE ALSO
  43
  44 L<ssl(3)|ssl(3)>, L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>,
  45 L<SSL_session_reused(3)|SSL_session_reused(3)>,
  46 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>
  47
  48 =cut