summaryrefslogtreecommitdiffstats
path: root/secure/lib/libssl/man/SSL_read.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_read.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_read.3')
-rw-r--r--secure/lib/libssl/man/SSL_read.375
1 files changed, 33 insertions, 42 deletions
diff --git a/secure/lib/libssl/man/SSL_read.3 b/secure/lib/libssl/man/SSL_read.3
index 5e41942..2404f7c 100644
--- a/secure/lib/libssl/man/SSL_read.3
+++ b/secure/lib/libssl/man/SSL_read.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:48 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_read 3"
-.TH SSL_read 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_read 3 "2006-07-29" "0.9.8b" "OpenSSL"
.SH "NAME"
-SSL_read \- read bytes from a \s-1TLS/SSL\s0 connection.
+SSL_read \- read bytes from a TLS/SSL connection.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
.Ve
+.PP
.Vb 1
\& int SSL_read(SSL *ssl, void *buf, int num);
.Ve
@@ -157,16 +148,16 @@ buffer \fBbuf\fR.
.SH "NOTES"
.IX Header "NOTES"
If necessary, \fISSL_read()\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_read()\fR operation. The behaviour of \fISSL_read()\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 \fISSL_read()\fR or SSL_write(3)
+\&\fISSL_set_connect_state\fR\|(3) or \fISSL_set_accept_state()\fR
+before the first call to an \fISSL_read()\fR or \fISSL_write\fR\|(3)
function.
.PP
\&\fISSL_read()\fR works based on the \s-1SSL/TLS\s0 records. The data are received in
@@ -188,12 +179,12 @@ If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_read()\fR will only retur
read 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_read()\fR will also return
when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_read()\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_read()\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_read()\fR can also cause write operations! The calling process
@@ -210,16 +201,16 @@ with the same arguments.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
The following return values can occur:
-.Ip ">0" 4
+.IP ">0" 4
.IX Item ">0"
The read operation was successful; the return value is the number of
bytes actually read from the \s-1TLS/SSL\s0 connection.
-.Ip "0" 4
+.IP "0" 4
The read operation was not successful. The reason may either be a clean
shutdown due to a \*(L"close notify\*(R" alert sent by the peer (in which case
the \s-1SSL_RECEIVED_SHUTDOWN\s0 flag in the ssl shutdown state is set
-(see SSL_shutdown(3),
-SSL_set_shutdown(3)). It is also possible, that
+(see \fISSL_shutdown\fR\|(3),
+\&\fISSL_set_shutdown\fR\|(3)). It is also possible, that
the peer simply shut down the underlying transport and the shutdown is
incomplete. 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
@@ -229,16 +220,16 @@ 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, whether the closure was initiated by the peer or by something
else.
-.Ip "<0" 4
+.IP "<0" 4
.IX Item "<0"
The read 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_write(3),
-SSL_CTX_set_mode(3), SSL_CTX_new(3),
-SSL_connect(3), SSL_accept(3)
-SSL_set_connect_state(3),
-SSL_shutdown(3), SSL_set_shutdown(3),
-ssl(3), bio(3)
+\&\fISSL_get_error\fR\|(3), \fISSL_write\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_shutdown\fR\|(3), \fISSL_set_shutdown\fR\|(3),
+\&\fIssl\fR\|(3), \fIbio\fR\|(3)
OpenPOWER on IntegriCloud