summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_free.3
diff options
context:
space:
mode:
authorbentley <>2014-10-12 09:33:04 +0000
committerbentley <>2014-10-12 09:33:04 +0000
commit82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch)
treea5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_free.3
parent0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff)
downloadopenbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz
openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2
openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet. ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_free.3')
-rw-r--r--src/lib/libssl/doc/SSL_free.359
1 files changed, 59 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_free.3 b/src/lib/libssl/doc/SSL_free.3
new file mode 100644
index 0000000000..453cd7d424
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_free.3
@@ -0,0 +1,59 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_FREE 3
3.Os
4.Sh NAME
5.Nm SSL_free
6.Nd free an allocated SSL structure
7.Sh SYNOPSIS
8.In openssl/ssl.h
9.Ft void
10.Fn SSL_free "SSL *ssl"
11.Sh DESCRIPTION
12.Fn SSL_free
13decrements the reference count of
14.Fa ssl ,
15and removes the
16.Vt SSL
17structure pointed to by
18.Fa ssl
19and frees up the allocated memory if the reference count has reached 0.
20.Sh NOTES
21.Fn SSL_free
22also calls the
23.Xr free 3 Ns
24ing procedures for indirectly affected items, if applicable: the buffering
25.Vt BIO ,
26the read and write
27.Vt BIOs ,
28cipher lists specially created for this
29.Fa ssl ,
30the
31.Sy SSL_SESSION .
32Do not explicitly free these indirectly freed up items before or after calling
33.Fn SSL_free ,
34as trying to free things twice may lead to program failure.
35.Pp
36The
37.Fa ssl
38session has reference counts from two users: the
39.Vt SSL
40object, for which the reference count is removed by
41.Fn SSL_free
42and the internal session cache.
43If the session is considered bad, because
44.Xr SSL_shutdown 3
45was not called for the connection and
46.Xr SSL_set_shutdown 3
47was not used to set the
48.Vt SSL_SENT_SHUTDOWN
49state, the session will also be removed from the session cache as required by
50RFC2246.
51.Sh RETURN VALUES
52.Fn SSL_free
53does not provide diagnostic information.
54.Sh SEE ALSO
55.Xr ssl 3 ,
56.Xr SSL_clear 3 ,
57.Xr SSL_new 3 ,
58.Xr SSL_set_shutdown 3 ,
59.Xr SSL_shutdown 3