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