projects
/
openssl.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
A few small corrections to the SSL documentation.
[openssl.git]
/
doc
/
ssl
/
SSL_write.pod
diff --git
a/doc/ssl/SSL_write.pod
b/doc/ssl/SSL_write.pod
index 4db85473d9a9c552848f07f5c4616d8f3b9f1bb8..7ce625ac215a83ae8c7d858e152ae2748338db59 100644
(file)
--- a/
doc/ssl/SSL_write.pod
+++ b/
doc/ssl/SSL_write.pod
@@
-13,10
+13,14
@@
SSL_read - write bytes to a TLS/SSL connection.
=head1 DESCRIPTION
SSL_write() writes B<num> bytes from the buffer B<buf> into the specified
=head1 DESCRIPTION
SSL_write() writes B<num> bytes from the buffer B<buf> into the specified
-B<ssl>. If necessary, SSL_write() will negotiate a TLS/SSL session, if
+B<ssl> connection.
+
+=head1 NOTES
+
+If necessary, SSL_write() will negotiate a TLS/SSL session, if
not already explicitly performed by SSL_connect() or SSL_accept(). If the
peer requests a re-negotiation, it will be performed transparently during
not already explicitly performed by SSL_connect() or SSL_accept(). If the
peer requests a re-negotiation, it will be performed transparently during
-the SSL_write() operation. The behavior of SSL_write() depends on the
+the SSL_write() operation. The behavio
u
r of SSL_write() depends on the
underlying BIO.
If the underlying BIO is B<blocking>, SSL_write() will only return, once the
underlying BIO.
If the underlying BIO is B<blocking>, SSL_write() will only return, once the
@@
-34,6
+38,12
@@
non-blocking socket, nothing is to be done, but select() can be used to check
for the required condition. When using a buffering BIO, like a BIO pair, data
must be written into or retrieved out of the BIO before being able to continue.
for the required condition. When using a buffering BIO, like a BIO pair, data
must be written into or retrieved out of the BIO before being able to continue.
+=head1 WARNING
+
+When an SSL_write() operation has to be repeated because of
+B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
+with the same arguments.
+
=head1 RETURN VALUES
The following return values can occur:
=head1 RETURN VALUES
The following return values can occur:
@@
-50,7
+60,7
@@
bytes actually written to the TLS/SSL connection.
The write operation was not successful. Call SSL_get_error() with the return
value B<ret> to find out, whether an error occurred.
The write operation was not successful. Call SSL_get_error() with the return
value B<ret> to find out, whether an error occurred.
-=item
-1
+=item
E<lt>0
The read operation was not successful, because either an error occurred
or action must be taken by the calling process. Call SSL_get_error() with the
The read operation was not successful, because either an error occurred
or action must be taken by the calling process. Call SSL_get_error() with the