diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_free.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_free.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_free.3 | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/src/lib/libssl/doc/SSL_free.3 b/src/lib/libssl/doc/SSL_free.3 deleted file mode 100644 index 1a3711e6c7..0000000000 --- a/src/lib/libssl/doc/SSL_free.3 +++ /dev/null | |||
@@ -1,67 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_free.3,v 1.3 2015/12/30 18:45:02 millert Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 30 2015 $ | ||
5 | .Dt SSL_FREE 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_free | ||
9 | .Nd free an allocated SSL structure | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft void | ||
13 | .Fn SSL_free "SSL *ssl" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_free | ||
16 | decrements the reference count of | ||
17 | .Fa ssl , | ||
18 | and removes the | ||
19 | .Vt SSL | ||
20 | structure pointed to by | ||
21 | .Fa ssl | ||
22 | and frees up the allocated memory if the reference count has reached 0. | ||
23 | If | ||
24 | .Fa ssl | ||
25 | is a | ||
26 | .Dv NULL | ||
27 | pointer, no action occurs. | ||
28 | .Sh NOTES | ||
29 | .Fn SSL_free | ||
30 | also calls the | ||
31 | .Xr free 3 Ns | ||
32 | ing procedures for indirectly affected items, if applicable: the buffering | ||
33 | .Vt BIO , | ||
34 | the read and write | ||
35 | .Vt BIOs , | ||
36 | cipher lists specially created for this | ||
37 | .Fa ssl , | ||
38 | the | ||
39 | .Sy SSL_SESSION . | ||
40 | Do not explicitly free these indirectly freed up items before or after calling | ||
41 | .Fn SSL_free , | ||
42 | as trying to free things twice may lead to program failure. | ||
43 | .Pp | ||
44 | The | ||
45 | .Fa ssl | ||
46 | session has reference counts from two users: the | ||
47 | .Vt SSL | ||
48 | object, for which the reference count is removed by | ||
49 | .Fn SSL_free | ||
50 | and the internal session cache. | ||
51 | If the session is considered bad, because | ||
52 | .Xr SSL_shutdown 3 | ||
53 | was not called for the connection and | ||
54 | .Xr SSL_set_shutdown 3 | ||
55 | was not used to set the | ||
56 | .Vt SSL_SENT_SHUTDOWN | ||
57 | state, the session will also be removed from the session cache as required by | ||
58 | RFC2246. | ||
59 | .Sh RETURN VALUES | ||
60 | .Fn SSL_free | ||
61 | does not provide diagnostic information. | ||
62 | .Sh SEE ALSO | ||
63 | .Xr ssl 3 , | ||
64 | .Xr SSL_clear 3 , | ||
65 | .Xr SSL_new 3 , | ||
66 | .Xr SSL_set_shutdown 3 , | ||
67 | .Xr SSL_shutdown 3 | ||