summaryrefslogtreecommitdiffstats
path: root/secure/lib/libssl/man/SSL_set_shutdown.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libssl/man/SSL_set_shutdown.3')
-rw-r--r--secure/lib/libssl/man/SSL_set_shutdown.360
1 files changed, 26 insertions, 34 deletions
diff --git a/secure/lib/libssl/man/SSL_set_shutdown.3 b/secure/lib/libssl/man/SSL_set_shutdown.3
index 8b69112..3de924c 100644
--- a/secure/lib/libssl/man/SSL_set_shutdown.3
+++ b/secure/lib/libssl/man/SSL_set_shutdown.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:49 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,23 +126,24 @@
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
.\"
.IX Title "SSL_set_shutdown 3"
-.TH SSL_set_shutdown 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_set_shutdown 3 "2006-07-29" "0.9.8b" "OpenSSL"
.SH "NAME"
-SSL_set_shutdown, SSL_get_shutdown \- manipulate shutdown state of an \s-1SSL\s0 connection
+SSL_set_shutdown, SSL_get_shutdown \- manipulate shutdown state of an SSL connection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
.Ve
+.PP
.Vb 1
\& void SSL_set_shutdown(SSL *ssl, int mode);
.Ve
+.PP
.Vb 1
-\& int SSL_get_shutdown(SSL *ssl);
+\& int SSL_get_shutdown(const SSL *ssl);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
@@ -161,13 +153,13 @@ SSL_set_shutdown, SSL_get_shutdown \- manipulate shutdown state of an \s-1SSL\s0
.SH "NOTES"
.IX Header "NOTES"
The shutdown state of an ssl connection is a bitmask of:
-.Ip "0" 4
+.IP "0" 4
No shutdown setting, yet.
-.Ip "\s-1SSL_SENT_SHUTDOWN\s0" 4
+.IP "\s-1SSL_SENT_SHUTDOWN\s0" 4
.IX Item "SSL_SENT_SHUTDOWN"
A \*(L"close notify\*(R" shutdown alert was sent to the peer, the connection is being
considered closed and the session is closed and correct.
-.Ip "\s-1SSL_RECEIVED_SHUTDOWN\s0" 4
+.IP "\s-1SSL_RECEIVED_SHUTDOWN\s0" 4
.IX Item "SSL_RECEIVED_SHUTDOWN"
A shutdown alert was received form the peer, either a normal \*(L"close notify\*(R"
or a fatal error.
@@ -176,18 +168,18 @@ or a fatal error.
.PP
The shutdown state of the connection is used to determine the state of
the ssl session. If the session is still open, when
-SSL_clear(3) or SSL_free(3) is called,
+\&\fISSL_clear\fR\|(3) or \fISSL_free\fR\|(3) is called,
it is considered bad and removed according to \s-1RFC2246\s0.
The actual condition for a correctly closed session is \s-1SSL_SENT_SHUTDOWN\s0
(according to the \s-1TLS\s0 \s-1RFC\s0, it is acceptable to only send the \*(L"close notify\*(R"
alert but to not wait for the peer's answer, when the underlying connection
is closed).
\&\fISSL_set_shutdown()\fR can be used to set this state without sending a
-close alert to the peer (see SSL_shutdown(3)).
+close alert to the peer (see \fISSL_shutdown\fR\|(3)).
.PP
If a \*(L"close notify\*(R" was received, \s-1SSL_RECEIVED_SHUTDOWN\s0 will be set,
for setting \s-1SSL_SENT_SHUTDOWN\s0 the application must however still call
-SSL_shutdown(3) or \fISSL_set_shutdown()\fR itself.
+\&\fISSL_shutdown\fR\|(3) or \fISSL_set_shutdown()\fR itself.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fISSL_set_shutdown()\fR does not return diagnostic information.
@@ -195,6 +187,6 @@ SSL_shutdown(3) or \fISSL_set_shutdown()\fR itself.
\&\fISSL_get_shutdown()\fR returns the current setting.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-ssl(3), SSL_shutdown(3),
-SSL_CTX_set_quiet_shutdown(3),
-SSL_clear(3), SSL_free(3)
+\&\fIssl\fR\|(3), \fISSL_shutdown\fR\|(3),
+\&\fISSL_CTX_set_quiet_shutdown\fR\|(3),
+\&\fISSL_clear\fR\|(3), \fISSL_free\fR\|(3)
OpenPOWER on IntegriCloud