diff options
author | Rob Austein <sra@hactrn.net> | 2006-10-09 16:00:16 +0000 |
---|---|---|
committer | Rob Austein <sra@hactrn.net> | 2006-10-09 16:00:16 +0000 |
commit | eb9264fc2ef786e8c4e3d430834b9b9e9e0b9c0a (patch) | |
tree | a72b0dcff12c4934f29502390553f0b2305b05fa /openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod | |
parent | 3a6e89edc0a52c58e2c08d3de4e360de777f14a7 (diff) |
OpenSSL 0.9.8d base code import
svn path=/openssl/vendor/0.9.8d/CHANGES; revision=373
Diffstat (limited to 'openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod')
-rw-r--r-- | openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod b/openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod new file mode 100644 index 00000000..2d4f8b61 --- /dev/null +++ b/openssl/vendor/0.9.8d/doc/ssl/SSL_free.pod @@ -0,0 +1,44 @@ +=pod + +=head1 NAME + +SSL_free - free 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. + +=head1 NOTES + +SSL_free() also calls the free()ing procedures for indirectly affected items, if +applicable: the buffering BIO, the read and write BIOs, +cipher lists specially created for this B<ssl>, the B<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. + +The ssl session has reference counts from two users: the SSL object, for +which the reference count is removed by SSL_free() and the internal +session cache. If the session is considered bad, because +L<SSL_shutdown(3)|SSL_shutdown(3)> was not called for the connection +and L<SSL_set_shutdown(3)|SSL_set_shutdown(3)> was not used to set the +SSL_SENT_SHUTDOWN state, the session will also be removed +from the session cache as required by RFC2246. + +=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_shutdown(3)|SSL_shutdown(3)>, L<SSL_set_shutdown(3)|SSL_set_shutdown(3)>, +L<ssl(3)|ssl(3)> + +=cut |