aboutsummaryrefslogtreecommitdiffstats
path: root/doc/ssl/SSL_new.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2000-09-14 13:11:56 +0000
committerRichard Levitte <levitte@openssl.org>2000-09-14 13:11:56 +0000
commitcc99526db1ee5b948736f6b07958a786fec1240b (patch)
tree24c07af7e38f014e2baa02ba5ce454e24d64211f /doc/ssl/SSL_new.pod
parent72660f5f15fcd71215193f993dd95da0d130168a (diff)
downloadopenssl-cc99526db1ee5b948736f6b07958a786fec1240b.tar.gz
Add a number of documentation files, mostly for SSL routines, but also
for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc/ssl/SSL_new.pod')
-rw-r--r--doc/ssl/SSL_new.pod42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/ssl/SSL_new.pod b/doc/ssl/SSL_new.pod
new file mode 100644
index 0000000000..a393c94c02
--- /dev/null
+++ b/doc/ssl/SSL_new.pod
@@ -0,0 +1,42 @@
+=pod
+
+=head1 NAME
+
+SSL_new - Create a new SSL structure for a connection
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ SSL *SSL_new(SSL_CTX *ctx);
+
+=head1 DESCRIPTION
+
+SSL_new() creates a new B<SSL> structure which is needed to hold the data
+for a SSL connection. The new SSL inherits the settings of the underlying
+context B<ctx>: connection method (SSLv2/v3/TLSv1), options, verification
+settings, timeout settings.
+
+=head1 RETURN VALUES
+
+The following return values can occur:
+
+=over 4
+
+=item NULL
+
+The creation of a new SSL failed. Check the error stack to find out the
+reason.
+
+=item Pointer to an SSL
+
+The return value points to an allocated SSL structure.
+
+=back
+
+=head1 SEE ALSO
+
+L<SSL_free(3)|SSL_free(3)>, L<SSL_clear(3)|SSL_clear(3)>,
+L<ssl(3)|ssl(3)>
+
+=cut