diff options
author | Lutz Jänicke <jaenicke@openssl.org> | 2001-02-13 14:00:09 +0000 |
---|---|---|
committer | Lutz Jänicke <jaenicke@openssl.org> | 2001-02-13 14:00:09 +0000 |
commit | 8e495e4ac7caa585fe28d3e7c2fe32dd1d3e94a8 (patch) | |
tree | 9edbc9cfb312c3cd0e3875f75bdfa5171bb9c31f /doc/ssl/SSL_free.pod | |
parent | 2afbd6fa08328c9de13bcd81776fe45ec3532b4c (diff) | |
download | openssl-8e495e4ac7caa585fe28d3e7c2fe32dd1d3e94a8.tar.gz |
Finish first round of session cache documentation.
Diffstat (limited to 'doc/ssl/SSL_free.pod')
-rw-r--r-- | doc/ssl/SSL_free.pod | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/ssl/SSL_free.pod b/doc/ssl/SSL_free.pod index f3f0c345f8..2d4f8b6168 100644 --- a/doc/ssl/SSL_free.pod +++ b/doc/ssl/SSL_free.pod @@ -16,18 +16,29 @@ 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 +=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 |