1=pod 2 3=head1 NAME 4 5SSL_free - free an allocated SSL structure 6 7=head1 SYNOPSIS 8 9 #include <openssl/ssl.h> 10 11 void SSL_free(SSL *ssl); 12 13=head1 DESCRIPTION 14 15SSL_free() decrements the reference count of B<ssl>, and removes the SSL 16structure pointed to by B<ssl> and frees up the allocated memory if the 17reference count has reached 0. 18If B<ssl> is NULL nothing is done. 19 20=head1 NOTES 21 22SSL_free() also calls the free()ing procedures for indirectly affected items, if 23applicable: the buffering BIO, the read and write BIOs, 24cipher lists specially created for this B<ssl>, the B<SSL_SESSION>. 25Do not explicitly free these indirectly freed up items before or after 26calling SSL_free(), as trying to free things twice may lead to program 27failure. 28 29The ssl session has reference counts from two users: the SSL object, for 30which the reference count is removed by SSL_free() and the internal 31session cache. If the session is considered bad, because 32L<SSL_shutdown(3)> was not called for the connection 33and L<SSL_set_shutdown(3)> was not used to set the 34SSL_SENT_SHUTDOWN state, the session will also be removed 35from the session cache as required by RFC2246. 36 37=head1 RETURN VALUES 38 39SSL_free() does not provide diagnostic information. 40 41L<SSL_new(3)>, L<SSL_clear(3)>, 42L<SSL_shutdown(3)>, L<SSL_set_shutdown(3)>, 43L<ssl(7)> 44 45=head1 COPYRIGHT 46 47Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. 48 49Licensed under the Apache License 2.0 (the "License"). You may not use 50this file except in compliance with the License. You can obtain a copy 51in the file LICENSE in the source distribution or at 52L<https://www.openssl.org/source/license.html>. 53 54=cut 55