summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_should_retry.pod
diff options
context:
space:
mode:
authorPaul Yang <yang.yang@baishancloud.com>2017-12-25 17:50:39 +0800
committerMatt Caswell <matt@openssl.org>2018-01-16 17:34:08 +0000
commit1f13ad311367c07fe71c9f911195cd25948184d7 (patch)
tree6293d1b483575295ea3786c1a07f3895141aedb6 /doc/man3/BIO_should_retry.pod
parent82992a4130e668c14ff66fca26170629b23c4556 (diff)
Add missing 'RETURN VALUES' sections in doc
All missing sections are added. Reviewed-by: Andy Polyakov <appro@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4976)
Diffstat (limited to 'doc/man3/BIO_should_retry.pod')
-rw-r--r--doc/man3/BIO_should_retry.pod15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/man3/BIO_should_retry.pod b/doc/man3/BIO_should_retry.pod
index 4d2d599e13..2becaca5ad 100644
--- a/doc/man3/BIO_should_retry.pod
+++ b/doc/man3/BIO_should_retry.pod
@@ -111,6 +111,19 @@ that is they cannot retry after a partial read or write. This is usually
worked around by only passing the relevant data to ASN1 functions when
the entire structure can be read or written.
+=head1 RETURN VALUES
+
+BIO_should_read(), BIO_should_write(), BIO_should_io_special(), and
+BIO_should_retry() return either 1 or 0 based on the actual conditions
+of the B<BIO>.
+
+BIO_retry_type() returns a flag combination presenting the cause of a retry
+condition or false if there is no retry condition.
+
+BIO_get_retry_BIO() returns a valid B<BIO> structure.
+
+BIO_get_retry_reason() returns the reason for a special condition.
+
=head1 SEE ALSO
L<bio>
@@ -122,7 +135,7 @@ OpenSSL 1.1.0.
=head1 COPYRIGHT
-Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy