diff options
author | Kurt Roeckx <kurt@roeckx.be> | 2018-05-13 11:24:11 +0200 |
---|---|---|
committer | Kurt Roeckx <kurt@roeckx.be> | 2018-07-17 00:01:00 +0200 |
commit | 57fd517066418472b3280a975823405fb8f2f43d (patch) | |
tree | e82253ddc65a03912444328d6bc5badf093eefbe /doc/man3/SSL_write.pod | |
parent | 07fc8d5207febe53c8203a8a89fb7ba006871a1b (diff) |
Improve documentation about reading and writing
Reviewed-by: Matt Caswell <matt@openssl.org>
GH: #6240
Diffstat (limited to 'doc/man3/SSL_write.pod')
-rw-r--r-- | doc/man3/SSL_write.pod | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/man3/SSL_write.pod b/doc/man3/SSL_write.pod index 14b651a1c3..d52844281f 100644 --- a/doc/man3/SSL_write.pod +++ b/doc/man3/SSL_write.pod @@ -34,10 +34,7 @@ L<SSL_set_connect_state(3)> or SSL_set_accept_state() before the first call to a write function. If the underlying BIO is B<blocking>, the write functions will only return, once -the write operation has been finished or an error occurred, except when a -renegotiation take place, in which case a SSL_ERROR_WANT_READ may occur. -This behaviour can be controlled with the SSL_MODE_AUTO_RETRY flag of the -L<SSL_CTX_set_mode(3)> call. +the write operation has been finished or an error occurred. If the underlying BIO is B<non-blocking> the write functions will also return when the underlying BIO could not satisfy the needs of the function to continue @@ -65,9 +62,13 @@ write is performed with the size of a message block, which is 16kB. When a write function call has to be repeated because L<SSL_get_error(3)> returned B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated with the same arguments. +The data that was passed might have been partially processed. +When B<SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER> was set using L<SSL_CTX_set_mode(3)> +the pointer can be different, but the data and length should still be the same. -When calling the write functions with num=0 bytes to be sent the behaviour is -undefined. +You should not call SSL_write() with num=0, it will return an error. +SSL_write_ex() can be called with num=0, but will not send application data to +the peer. =head1 RETURN VALUES @@ -103,6 +104,10 @@ You should instead call SSL_get_error() to find out if it's retryable. =back +=head1 HISTORY + +SSL_write_ex() was added in OpenSSL 1.1.1. + =head1 SEE ALSO L<SSL_get_error(3)>, L<SSL_read_ex(3)>, L<SSL_read(3)> |