1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "SSL_set_shutdown 3"
132 .TH SSL_set_shutdown 3 "2018-03-27" "1.0.2o" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 SSL_set_shutdown, SSL_get_shutdown \- manipulate shutdown state of an SSL connection
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/ssl.h>
144 \& void SSL_set_shutdown(SSL *ssl, int mode);
146 \& int SSL_get_shutdown(const SSL *ssl);
149 .IX Header "DESCRIPTION"
150 \&\fISSL_set_shutdown()\fR sets the shutdown state of \fBssl\fR to \fBmode\fR.
152 \&\fISSL_get_shutdown()\fR returns the shutdown mode of \fBssl\fR.
155 The shutdown state of an ssl connection is a bitmask of:
157 No shutdown setting, yet.
158 .IP "\s-1SSL_SENT_SHUTDOWN\s0" 4
159 .IX Item "SSL_SENT_SHUTDOWN"
160 A \*(L"close notify\*(R" shutdown alert was sent to the peer, the connection is being
161 considered closed and the session is closed and correct.
162 .IP "\s-1SSL_RECEIVED_SHUTDOWN\s0" 4
163 .IX Item "SSL_RECEIVED_SHUTDOWN"
164 A shutdown alert was received form the peer, either a normal \*(L"close notify\*(R"
167 \&\s-1SSL_SENT_SHUTDOWN\s0 and \s-1SSL_RECEIVED_SHUTDOWN\s0 can be set at the same time.
169 The shutdown state of the connection is used to determine the state of
170 the ssl session. If the session is still open, when
171 \&\fISSL_clear\fR\|(3) or \fISSL_free\fR\|(3) is called,
172 it is considered bad and removed according to \s-1RFC2246.\s0
173 The actual condition for a correctly closed session is \s-1SSL_SENT_SHUTDOWN
174 \&\s0(according to the \s-1TLS RFC,\s0 it is acceptable to only send the \*(L"close notify\*(R"
175 alert but to not wait for the peer's answer, when the underlying connection
177 \&\fISSL_set_shutdown()\fR can be used to set this state without sending a
178 close alert to the peer (see \fISSL_shutdown\fR\|(3)).
180 If a \*(L"close notify\*(R" was received, \s-1SSL_RECEIVED_SHUTDOWN\s0 will be set,
181 for setting \s-1SSL_SENT_SHUTDOWN\s0 the application must however still call
182 \&\fISSL_shutdown\fR\|(3) or \fISSL_set_shutdown()\fR itself.
184 .IX Header "RETURN VALUES"
185 \&\fISSL_set_shutdown()\fR does not return diagnostic information.
187 \&\fISSL_get_shutdown()\fR returns the current setting.
189 .IX Header "SEE ALSO"
190 \&\fIssl\fR\|(3), \fISSL_shutdown\fR\|(3),
191 \&\fISSL_CTX_set_quiet_shutdown\fR\|(3),
192 \&\fISSL_clear\fR\|(3), \fISSL_free\fR\|(3)