1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "SSL_SESSION_free 3"
127 .TH SSL_SESSION_free 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 SSL_SESSION_free \- free an allocated SSL_SESSION structure
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/ssl.h>
139 \& void SSL_SESSION_free(SSL_SESSION *session);
142 .IX Header "DESCRIPTION"
143 \&\fISSL_SESSION_free()\fR decrements the reference count of \fBsession\fR and removes
144 the \fB\s-1SSL_SESSION\s0\fR structure pointed to by \fBsession\fR and frees up the allocated
145 memory, if the the reference count has reached 0.
148 \&\s-1SSL_SESSION\s0 objects are allocated, when a \s-1TLS/SSL\s0 handshake operation
149 is successfully completed. Depending on the settings, see
150 \&\fISSL_CTX_set_session_cache_mode\fR\|(3),
151 the \s-1SSL_SESSION\s0 objects are internally referenced by the \s-1SSL_CTX\s0 and
152 linked into its session cache. \s-1SSL\s0 objects may be using the \s-1SSL_SESSION\s0 object;
153 as a session may be reused, several \s-1SSL\s0 objects may be using one \s-1SSL_SESSION\s0
154 object at the same time. It is therefore crucial to keep the reference
155 count (usage information) correct and not delete a \s-1SSL_SESSION\s0 object
156 that is still used, as this may lead to program failures due to
157 dangling pointers. These failures may also appear delayed, e.g.
158 when an \s-1SSL_SESSION\s0 object was completely freed as the reference count
159 incorrectly became 0, but it is still referenced in the internal
160 session cache and the cache list is processed during a
161 \&\fISSL_CTX_flush_sessions\fR\|(3) operation.
163 \&\fISSL_SESSION_free()\fR must only be called for \s-1SSL_SESSION\s0 objects, for
164 which the reference count was explicitly incremented (e.g.
165 by calling \fISSL_get1_session()\fR, see \fISSL_get_session\fR\|(3))
166 or when the \s-1SSL_SESSION\s0 object was generated outside a \s-1TLS\s0 handshake
167 operation, e.g. by using \fId2i_SSL_SESSION\fR\|(3).
168 It must not be called on other \s-1SSL_SESSION\s0 objects, as this would cause
169 incorrect reference counts and therefore program failures.
171 .IX Header "RETURN VALUES"
172 \&\fISSL_SESSION_free()\fR does not provide diagnostic information.
174 .IX Header "SEE ALSO"
175 \&\fIssl\fR\|(3), \fISSL_get_session\fR\|(3),
176 \&\fISSL_CTX_set_session_cache_mode\fR\|(3),
177 \&\fISSL_CTX_flush_sessions\fR\|(3),
178 \fId2i_SSL_SESSION\fR\|(3)