RT1941: c_rehash.pod is missing
[openssl.git] / doc / ssl / SSL_CTX_free.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_free - free an allocated SSL_CTX object
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_CTX_free(SSL_CTX *ctx);
12
13 =head1 DESCRIPTION
14
15 SSL_CTX_free() decrements the reference count of B<ctx>, and removes the
16 SSL_CTX object pointed to by B<ctx> 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 session cache, the list of ciphers, the list of Client CAs,
21 the certificates and keys.
22
23 =head1 WARNINGS
24
25 If a session-remove callback is set (SSL_CTX_sess_set_remove_cb()), this
26 callback will be called for each session being freed from B<ctx>'s
27 session cache. This implies, that all corresponding sessions from an
28 external session cache are removed as well. If this is not desired, the user
29 should explicitly unset the callback by calling
30 SSL_CTX_sess_set_remove_cb(B<ctx>, NULL) prior to calling SSL_CTX_free().
31
32 =head1 RETURN VALUES
33
34 SSL_CTX_free() does not provide diagnostic information.
35
36 =head1 SEE ALSO
37
38 L<SSL_CTX_new(3)|SSL_CTX_new(3)>, L<ssl(3)|ssl(3)>,
39 L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>
40
41 =cut