crypto/openssl/doc/ssl/SSL_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_new - create a new SSL structure for a connection
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  SSL *SSL_new(SSL_CTX *ctx);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_new() creates a new B<SSL> structure which is needed to hold the
  16 data for a TLS/SSL connection. The new structure inherits the settings
  17 of the underlying context B<ctx>: connection method (SSLv2/v3/TLSv1),
  18 options, verification settings, timeout settings.
  19
  20 =head1 RETURN VALUES
  21
  22 The following return values can occur:
  23
  24 =over 4
  25
  26 =item NULL
  27
  28 The creation of a new SSL structure failed. Check the error stack to
  29 find out the reason.
  30
  31 =item Pointer to an SSL structure
  32
  33 The return value points to an allocated SSL structure.
  34
  35 =back
  36
  37 =head1 SEE ALSO
  38
  39 L<SSL_free(3)|SSL_free(3)>, L<SSL_clear(3)|SSL_clear(3)>,
  40 L<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)>,
  41 L<SSL_get_SSL_CTX(3)|SSL_get_SSL_CTX(3)>,
  42 L<ssl(3)|ssl(3)>
  43
  44 =cut