summaryrefslogtreecommitdiffstats
path: root/secure/lib/libssl/man/SSL_write.3
diff options
context:
space:
mode:
authorsimon <simon@FreeBSD.org>2006-07-29 19:41:41 +0000
committersimon <simon@FreeBSD.org>2006-07-29 19:41:41 +0000
commit018ef6efe1e20b420eaa3afdaa37b0abeba93a1a (patch)
treee9b6155f49a3b6073b95b808e1e0a1ec5489a21f /secure/lib/libssl/man/SSL_write.3
parent152e76d1d1dcc649357b52f30943345b06aa162c (diff)
downloadFreeBSD-src-018ef6efe1e20b420eaa3afdaa37b0abeba93a1a.zip
FreeBSD-src-018ef6efe1e20b420eaa3afdaa37b0abeba93a1a.tar.gz
Upgrade to OpenSSL 0.9.8b.
Diffstat (limited to 'secure/lib/libssl/man/SSL_write.3')
-rw-r--r--secure/lib/libssl/man/SSL_write.371
1 files changed, 31 insertions, 40 deletions
diff --git a/secure/lib/libssl/man/SSL_write.3 b/secure/lib/libssl/man/SSL_write.3
index 4edfc84..dff29b4 100644
--- a/secure/lib/libssl/man/SSL_write.3
+++ b/secure/lib/libssl/man/SSL_write.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:50 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_write 3"
-.TH SSL_write 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_write 3 "2006-07-29" "0.9.8b" "OpenSSL"
.SH "NAME"
-SSL_write \- write bytes to a \s-1TLS/SSL\s0 connection.
+SSL_write \- write bytes to a TLS/SSL connection.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
.Ve
+.PP
.Vb 1
\& int SSL_write(SSL *ssl, const void *buf, int num);
.Ve
@@ -157,27 +148,27 @@ SSL_write \- write bytes to a \s-1TLS/SSL\s0 connection.
.SH "NOTES"
.IX Header "NOTES"
If necessary, \fISSL_write()\fR will negotiate a \s-1TLS/SSL\s0 session, if
-not already explicitly performed by SSL_connect(3) or
-SSL_accept(3). If the
-peer requests a re-negotiation, it will be performed transparently during
+not already explicitly performed by \fISSL_connect\fR\|(3) or
+\&\fISSL_accept\fR\|(3). If the
+peer requests a re\-negotiation, it will be performed transparently during
the \fISSL_write()\fR operation. The behaviour of \fISSL_write()\fR depends on the
underlying \s-1BIO\s0.
.PP
For the transparent negotiation to succeed, the \fBssl\fR must have been
initialized to client or server mode. This is being done by calling
-SSL_set_connect_state(3) or \fISSL_set_accept_state()\fR
-before the first call to an SSL_read(3) or \fISSL_write()\fR function.
+\&\fISSL_set_connect_state\fR\|(3) or \fISSL_set_accept_state()\fR
+before the first call to an \fISSL_read\fR\|(3) or \fISSL_write()\fR function.
.PP
If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_write()\fR will only return, once the
write operation has been finished or an error occurred, except when a
renegotiation take place, in which case a \s-1SSL_ERROR_WANT_READ\s0 may occur.
This behaviour can be controlled with the \s-1SSL_MODE_AUTO_RETRY\s0 flag of the
-SSL_CTX_set_mode(3) call.
+\&\fISSL_CTX_set_mode\fR\|(3) call.
.PP
If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_write()\fR will also return,
when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_write()\fR
to continue the operation. In this case a call to
-SSL_get_error(3) with the
+\&\fISSL_get_error\fR\|(3) with the
return value of \fISSL_write()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
\&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. As at any time a re-negotiation is possible, a
call to \fISSL_write()\fR can also cause read operations! The calling process
@@ -190,7 +181,7 @@ must be written into or retrieved out of the \s-1BIO\s0 before being able to con
\&\fISSL_write()\fR will only return with success, when the complete contents
of \fBbuf\fR of length \fBnum\fR has been written. This default behaviour
can be changed with the \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 option of
-SSL_CTX_set_mode(3). When this flag is set,
+\&\fISSL_CTX_set_mode\fR\|(3). When this flag is set,
\&\fISSL_write()\fR will also return with success, when a partial write has been
successfully completed. In this case the \fISSL_write()\fR operation is considered
completed. The bytes are sent and a new \fISSL_write()\fR operation with a new
@@ -208,11 +199,11 @@ undefined.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
The following return values can occur:
-.Ip ">0" 4
+.IP ">0" 4
.IX Item ">0"
The write operation was successful, the return value is the number of
bytes actually written to the \s-1TLS/SSL\s0 connection.
-.Ip "0" 4
+.IP "0" 4
The write operation was not successful. Probably the underlying connection
was closed. Call \fISSL_get_error()\fR with the return value \fBret\fR to find out,
whether an error occurred or the connection was shut down cleanly
@@ -221,15 +212,15 @@ whether an error occurred or the connection was shut down cleanly
SSLv2 (deprecated) does not support a shutdown alert protocol, so it can
only be detected, whether the underlying connection was closed. It cannot
be checked, why the closure happened.
-.Ip "<0" 4
+.IP "<0" 4
.IX Item "<0"
The write operation was not successful, because either an error occurred
or action must be taken by the calling process. Call \fISSL_get_error()\fR with the
return value \fBret\fR to find out the reason.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-SSL_get_error(3), SSL_read(3),
-SSL_CTX_set_mode(3), SSL_CTX_new(3),
-SSL_connect(3), SSL_accept(3)
-SSL_set_connect_state(3),
-ssl(3), bio(3)
+\&\fISSL_get_error\fR\|(3), \fISSL_read\fR\|(3),
+\&\fISSL_CTX_set_mode\fR\|(3), \fISSL_CTX_new\fR\|(3),
+\&\fISSL_connect\fR\|(3), \fISSL_accept\fR\|(3)
+\&\fISSL_set_connect_state\fR\|(3),
+\&\fIssl\fR\|(3), \fIbio\fR\|(3)
OpenPOWER on IntegriCloud