summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_CTX_free.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_free.3')
-rw-r--r--src/lib/libssl/doc/SSL_CTX_free.344
1 files changed, 44 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_free.3 b/src/lib/libssl/doc/SSL_CTX_free.3
new file mode 100644
index 0000000000..9cf5934303
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_CTX_free.3
@@ -0,0 +1,44 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_CTX_FREE 3
3.Os
4.Sh NAME
5.Nm SSL_CTX_free
6.Nd free an allocated SSL_CTX object
7.Sh SYNOPSIS
8.In openssl/ssl.h
9.Ft void
10.Fn SSL_CTX_free "SSL_CTX *ctx"
11.Sh DESCRIPTION
12.Fn SSL_CTX_free
13decrements the reference count of
14.Fa ctx ,
15and removes the
16.Vt SSL_CTX
17object pointed to by
18.Fa ctx
19and frees up the allocated memory if the reference count has reached 0.
20.Pp
21It also calls the
22.Xr free 3 Ns ing procedures for indirectly affected items, if applicable:
23the session cache, the list of ciphers, the list of Client CAs,
24the certificates and keys.
25.Sh WARNINGS
26If a session-remove callback is set
27.Pq Xr SSL_CTX_sess_set_remove_cb 3 ,
28this callback will be called for each session being freed from
29.Fa ctx Ns 's
30session cache.
31This implies that all corresponding sessions from an external session cache are
32removed as well.
33If this is not desired, the user should explicitly unset the callback by
34calling
35.Fn SSL_CTX_sess_set_remove_cb ctx NULL
36prior to calling
37.Fn SSL_CTX_free .
38.Sh RETURN VALUES
39.Fn SSL_CTX_free
40does not provide diagnostic information.
41.Sh SEE ALSO
42.Xr ssl 3 ,
43.Xr SSL_CTX_new 3 ,
44.Xr SSL_CTX_sess_set_get_cb 3