1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Thu May 9 13:20:42 2002
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "SSL_SESSION_FREE 1"
141 .TH SSL_SESSION_FREE 1 "perl v5.6.1" "2002-01-27" "User Contributed Perl Documentation"
144 SSL_SESSION_free \- free an allocated \s-1SSL_SESSION\s0 structure
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/ssl.h>
151 \& void SSL_SESSION_free(SSL_SESSION *session);
154 .IX Header "DESCRIPTION"
155 \&\fISSL_SESSION_free()\fR decrements the reference count of \fBsession\fR and removes
156 the \fB\s-1SSL_SESSION\s0\fR structure pointed to by \fBsession\fR and frees up the allocated
157 memory, if the the reference count has reached 0.
160 \&\s-1SSL_SESSION\s0 objects are allocated, when a \s-1TLS/SSL\s0 handshake operation
161 is successfully completed. Depending on the settings, see
162 SSL_CTX_set_session_cache_mode(3),
163 the \s-1SSL_SESSION\s0 objects are internally referenced by the \s-1SSL_CTX\s0 and
164 linked into its session cache. \s-1SSL\s0 objects may be using the \s-1SSL_SESSION\s0 object;
165 as a session may be reused, several \s-1SSL\s0 objects may be using one \s-1SSL_SESSION\s0
166 object at the same time. It is therefore crucial to keep the reference
167 count (usage information) correct and not delete a \s-1SSL_SESSION\s0 object
168 that is still used, as this may lead to program failures due to
169 dangling pointers. These failures may also appear delayed, e.g.
170 when an \s-1SSL_SESSION\s0 object was completely freed as the reference count
171 incorrectly became 0, but it is still referenced in the internal
172 session cache and the cache list is processed during a
173 SSL_CTX_flush_sessions(3) operation.
175 \&\fISSL_SESSION_free()\fR must only be called for \s-1SSL_SESSION\s0 objects, for
176 which the reference count was explicitly incremented (e.g.
177 by calling \fISSL_get1_session()\fR, see SSL_get_session(3))
178 or when the \s-1SSL_SESSION\s0 object was generated outside a \s-1TLS\s0 handshake
179 operation, e.g. by using d2i_SSL_SESSION(3).
180 It must not be called on other \s-1SSL_SESSION\s0 objects, as this would cause
181 incorrect reference counts and therefore program failures.
183 .IX Header "RETURN VALUES"
184 \&\fISSL_SESSION_free()\fR does not provide diagnostic information.
186 .IX Header "SEE ALSO"
187 ssl(3), SSL_get_session(3),
188 SSL_CTX_set_session_cache_mode(3),
189 SSL_CTX_flush_sessions(3),