summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_should_retry.pod
diff options
context:
space:
mode:
authorKurt Roeckx <kurt@roeckx.be>2018-05-13 11:24:11 +0200
committerKurt Roeckx <kurt@roeckx.be>2018-07-17 00:01:00 +0200
commit57fd517066418472b3280a975823405fb8f2f43d (patch)
treee82253ddc65a03912444328d6bc5badf093eefbe /doc/man3/BIO_should_retry.pod
parent07fc8d5207febe53c8203a8a89fb7ba006871a1b (diff)
Improve documentation about reading and writing
Reviewed-by: Matt Caswell <matt@openssl.org> GH: #6240
Diffstat (limited to 'doc/man3/BIO_should_retry.pod')
-rw-r--r--doc/man3/BIO_should_retry.pod10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man3/BIO_should_retry.pod b/doc/man3/BIO_should_retry.pod
index 60d8139030..7a9ce8ccbb 100644
--- a/doc/man3/BIO_should_retry.pod
+++ b/doc/man3/BIO_should_retry.pod
@@ -32,11 +32,13 @@ should then be retried at a later time.
If BIO_should_retry() is false then the cause is an error condition.
-BIO_should_read() is true if the cause of the condition is that a BIO
-needs to read data.
+BIO_should_read() is true if the cause of the condition is that the BIO
+has insufficient data to return. Check for readability and/or retry the
+last operation.
-BIO_should_write() is true if the cause of the condition is that a BIO
-needs to read data.
+BIO_should_write() is true if the cause of the condition is that the BIO
+has pending data to write. Check for writability and/or retry the
+last operation.
BIO_should_io_special() is true if some "special" condition, that is a
reason other than reading or writing is the cause of the condition.