diff options
| author | Paul Yang <yang.yang@baishancloud.com> | 2017-12-25 17:50:39 +0800 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2018-01-16 17:34:08 +0000 |
| commit | 1f13ad311367c07fe71c9f911195cd25948184d7 (patch) | |
| tree | 6293d1b483575295ea3786c1a07f3895141aedb6 /doc/man3/BIO_f_ssl.pod | |
| parent | 82992a4130e668c14ff66fca26170629b23c4556 (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_f_ssl.pod')
| -rw-r--r-- | doc/man3/BIO_f_ssl.pod | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/man3/BIO_f_ssl.pod b/doc/man3/BIO_f_ssl.pod index 571584c148..4119fc9195 100644 --- a/doc/man3/BIO_f_ssl.pod +++ b/doc/man3/BIO_f_ssl.pod @@ -271,6 +271,22 @@ a client and also echoes the request to standard output. BIO_flush(sbio); BIO_free_all(sbio); +=head1 RETURN VALUES + +BIO_f_ssl() returns the SSL B<BIO_METHOD> structure. + +BIO_set_ssl(), BIO_get_ssl(), BIO_set_ssl_mode(), BIO_set_ssl_renegotiate_bytes(), +BIO_set_ssl_renegotiate_timeout() and BIO_get_num_renegotiates() return 1 on +success or a value which is less than or equal to 0 if an error occurred. + +BIO_new_ssl(), BIO_new_ssl_connect() and BIO_new_buffer_ssl_connect() return +a valid B<BIO> structure on success or B<NULL> if an error occurred. + +BIO_ssl_copy_session_id() returns 1 on success or 0 on error. + +BIO_do_handshake() returns 1 if the connection was established successfully. +A zero or negative value is returned if the connection could not be established. + =head1 HISTORY In OpenSSL before 1.0.0 the BIO_pop() call was handled incorrectly, @@ -282,7 +298,7 @@ be modified to handle this fix or they may free up an already freed BIO. =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 |