"DESCRIPTION" is required.
[openssl.git] / doc / ssl / SSL_free.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_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
15 SSL_free() decrements the reference count of B<ssl>, and removes the SSL
16 structure pointed to by B<ssl> and frees up the allocated memory if the
17 the reference count has reached 0.
18
19 It also calls the free()ing procedures for indirectly affected items, if
20 applicable: the buffering BIO, the read and write BIOs,
21 cipher lists specially created for this B<ssl>, the B<SSL_SESSION>.
22 Do not explicitly free these indirectly freed up items before or after
23 calling SSL_free(), as trying to free things twice may lead to program
24 failure.
25
26 =head1 RETURN VALUES
27
28 SSL_free() does not provide diagnostic information.
29
30 L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
31 L<ssl(3)|ssl(3)>
32
33 =cut