summaryrefslogtreecommitdiffstats
path: root/secure/lib/libssl/man/SSL_SESSION_free.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libssl/man/SSL_SESSION_free.3')
-rw-r--r--secure/lib/libssl/man/SSL_SESSION_free.355
1 files changed, 23 insertions, 32 deletions
diff --git a/secure/lib/libssl/man/SSL_SESSION_free.3 b/secure/lib/libssl/man/SSL_SESSION_free.3
index 9d01628..f41f2fc 100644
--- a/secure/lib/libssl/man/SSL_SESSION_free.3
+++ b/secure/lib/libssl/man/SSL_SESSION_free.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:43 2003
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
@@ -15,12 +14,6 @@
.if t .sp .5v
.if n .sp
..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
.de Vb \" Begin verbatim text
.ft CW
.nf
@@ -28,15 +21,14 @@
..
.de Ve \" End verbatim text
.ft R
-
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available. \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
@@ -56,10 +48,10 @@
. ds R" ''
'br\}
.\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD. Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
@@ -68,14 +60,13 @@
. rr F
.\}
.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
-.bd B 3
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
@@ -135,18 +126,18 @@
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
.\"
.IX Title "SSL_SESSION_free 3"
-.TH SSL_SESSION_free 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_SESSION_free 3 "2006-07-29" "0.9.8b" "OpenSSL"
.SH "NAME"
-SSL_SESSION_free \- free an allocated \s-1SSL_SESSION\s0 structure
+SSL_SESSION_free \- free an allocated SSL_SESSION structure
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
.Ve
+.PP
.Vb 1
\& void SSL_SESSION_free(SSL_SESSION *session);
.Ve
@@ -159,7 +150,7 @@ memory, if the the reference count has reached 0.
.IX Header "NOTES"
\&\s-1SSL_SESSION\s0 objects are allocated, when a \s-1TLS/SSL\s0 handshake operation
is successfully completed. Depending on the settings, see
-SSL_CTX_set_session_cache_mode(3),
+\&\fISSL_CTX_set_session_cache_mode\fR\|(3),
the \s-1SSL_SESSION\s0 objects are internally referenced by the \s-1SSL_CTX\s0 and
linked into its session cache. \s-1SSL\s0 objects may be using the \s-1SSL_SESSION\s0 object;
as a session may be reused, several \s-1SSL\s0 objects may be using one \s-1SSL_SESSION\s0
@@ -170,13 +161,13 @@ dangling pointers. These failures may also appear delayed, e.g.
when an \s-1SSL_SESSION\s0 object was completely freed as the reference count
incorrectly became 0, but it is still referenced in the internal
session cache and the cache list is processed during a
-SSL_CTX_flush_sessions(3) operation.
+\&\fISSL_CTX_flush_sessions\fR\|(3) operation.
.PP
\&\fISSL_SESSION_free()\fR must only be called for \s-1SSL_SESSION\s0 objects, for
which the reference count was explicitly incremented (e.g.
-by calling \fISSL_get1_session()\fR, see SSL_get_session(3))
+by calling \fISSL_get1_session()\fR, see \fISSL_get_session\fR\|(3))
or when the \s-1SSL_SESSION\s0 object was generated outside a \s-1TLS\s0 handshake
-operation, e.g. by using d2i_SSL_SESSION(3).
+operation, e.g. by using \fId2i_SSL_SESSION\fR\|(3).
It must not be called on other \s-1SSL_SESSION\s0 objects, as this would cause
incorrect reference counts and therefore program failures.
.SH "RETURN VALUES"
@@ -184,7 +175,7 @@ incorrect reference counts and therefore program failures.
\&\fISSL_SESSION_free()\fR does not provide diagnostic information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-ssl(3), SSL_get_session(3),
-SSL_CTX_set_session_cache_mode(3),
-SSL_CTX_flush_sessions(3),
- d2i_SSL_SESSION(3)
+\&\fIssl\fR\|(3), \fISSL_get_session\fR\|(3),
+\&\fISSL_CTX_set_session_cache_mode\fR\|(3),
+\&\fISSL_CTX_flush_sessions\fR\|(3),
+ \fId2i_SSL_SESSION\fR\|(3)
OpenPOWER on IntegriCloud