aboutsummaryrefslogtreecommitdiff
path: root/doc/ssl/SSL_free.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_free.pod
parent72660f5f15fcd71215193f993dd95da0d130168a (diff)
downloadopenssl-cc99526db1ee5b948736f6b07958a786fec1240b.zip
openssl-cc99526db1ee5b948736f6b07958a786fec1240b.tar.gz
openssl-cc99526db1ee5b948736f6b07958a786fec1240b.tar.bz2
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_free.pod')
-rw-r--r--doc/ssl/SSL_free.pod33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/ssl/SSL_free.pod b/doc/ssl/SSL_free.pod
new file mode 100644
index 0000000..3d01234
--- /dev/null
+++ b/doc/ssl/SSL_free.pod
@@ -0,0 +1,33 @@
+=pod
+
+=head1 NAME
+
+SSL_free - Free up an allocated SSL structure
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ void *SSL_free(SSL *ssl);
+
+=head1 DESCRIPTION
+
+SSL_free() decrements the reference count of B<ssl> and removes the SSL
+structure pointed to by B<ssl> and frees up the allocated memory, if the
+the reference count has reached 0.
+
+It also calls the free()ing procedures for indirectly affected items, if
+applicable: the buffering BIO, the read and write BIOs,
+cipher lists especially created for this B<ssl>, the SSL_SESSION.
+Do not explicitly free these indirectly freed up items before or after
+calling SSL_free(), as trying to free things twice may lead to program
+failure.
+
+=head1 RETURN VALUES
+
+SSL_free() does not provide diagnostic information.
+
+L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
+L<ssl(3)|ssl(3)>
+
+=cut