summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_free.3
diff options
context:
space:
mode:
authorcvs2svn <admin@example.com>2015-03-08 16:48:49 +0000
committercvs2svn <admin@example.com>2015-03-08 16:48:49 +0000
commitdecf84ba5550c1656a7fdb51b5b81969590c3f03 (patch)
tree44872802e872bdfd60730fa9cf01d9d5751251c1 /src/lib/libssl/doc/SSL_free.3
parent7a8f138352aa4eb7b65ac4b1a5fe7630fbee1427 (diff)
downloadopenbsd-libressl-v2.1.5.tar.gz
openbsd-libressl-v2.1.5.tar.bz2
openbsd-libressl-v2.1.5.zip
This commit was manufactured by cvs2git to create branch 'OPENBSD_5_7'.libressl-v2.1.5
Diffstat (limited to 'src/lib/libssl/doc/SSL_free.3')
-rw-r--r--src/lib/libssl/doc/SSL_free.362
1 files changed, 0 insertions, 62 deletions
diff --git a/src/lib/libssl/doc/SSL_free.3 b/src/lib/libssl/doc/SSL_free.3
deleted file mode 100644
index c0078d817a..0000000000
--- a/src/lib/libssl/doc/SSL_free.3
+++ /dev/null
@@ -1,62 +0,0 @@
1.\"
2.\" $OpenBSD: SSL_free.3,v 1.2 2014/12/02 14:11:01 jmc Exp $
3.\"
4.Dd $Mdocdate: December 2 2014 $
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
16decrements the reference count of
17.Fa ssl ,
18and removes the
19.Vt SSL
20structure pointed to by
21.Fa ssl
22and frees up the allocated memory if the reference count has reached 0.
23.Sh NOTES
24.Fn SSL_free
25also calls the
26.Xr free 3 Ns
27ing procedures for indirectly affected items, if applicable: the buffering
28.Vt BIO ,
29the read and write
30.Vt BIOs ,
31cipher lists specially created for this
32.Fa ssl ,
33the
34.Sy SSL_SESSION .
35Do not explicitly free these indirectly freed up items before or after calling
36.Fn SSL_free ,
37as trying to free things twice may lead to program failure.
38.Pp
39The
40.Fa ssl
41session has reference counts from two users: the
42.Vt SSL
43object, for which the reference count is removed by
44.Fn SSL_free
45and the internal session cache.
46If the session is considered bad, because
47.Xr SSL_shutdown 3
48was not called for the connection and
49.Xr SSL_set_shutdown 3
50was not used to set the
51.Vt SSL_SENT_SHUTDOWN
52state, the session will also be removed from the session cache as required by
53RFC2246.
54.Sh RETURN VALUES
55.Fn SSL_free
56does not provide diagnostic information.
57.Sh SEE ALSO
58.Xr ssl 3 ,
59.Xr SSL_clear 3 ,
60.Xr SSL_new 3 ,
61.Xr SSL_set_shutdown 3 ,
62.Xr SSL_shutdown 3