diff options
| author | Miquel Ruiz <mruiz@cpan.org> | 2018-10-22 22:34:57 +0100 |
|---|---|---|
| committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-06-19 15:12:23 +0200 |
| commit | 441c1e093feb9c98733a0fc524b7f82661de2322 (patch) | |
| tree | 7edca6901235d23d23085af162310f2bd3a2912e | |
| parent | 444ec8d5e78c37c456b46297d809535b5434137a (diff) | |
Add SSL_shutdown to SSL_get_error's documentation
SSL_shutdown can fail if called during initialization, and in such case, it'll
add an error to the error queue. This adds SSL_shutdown to the list of functions
that should preceed the call to SSL_get_error.
CLA: trivial
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/7465)
(cherry picked from commit df9fd168ceb1f187365d24fef829d6d48b1077a9)
| -rw-r--r-- | doc/man3/SSL_get_error.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/SSL_get_error.pod b/doc/man3/SSL_get_error.pod index 32668a036d..97320a6c15 100644 --- a/doc/man3/SSL_get_error.pod +++ b/doc/man3/SSL_get_error.pod @@ -14,9 +14,9 @@ SSL_get_error - obtain result code for TLS/SSL I/O operation SSL_get_error() returns a result code (suitable for the C "switch" statement) for a preceding call to SSL_connect(), SSL_accept(), SSL_do_handshake(), -SSL_read_ex(), SSL_read(), SSL_peek_ex(), SSL_peek(), SSL_write_ex() or -SSL_write() on B<ssl>. The value returned by that TLS/SSL I/O function must be -passed to SSL_get_error() in parameter B<ret>. +SSL_read_ex(), SSL_read(), SSL_peek_ex(), SSL_peek(), SSL_shutdown(), +SSL_write_ex() or SSL_write() on B<ssl>. The value returned by that TLS/SSL I/O +function must be passed to SSL_get_error() in parameter B<ret>. In addition to B<ssl> and B<ret>, SSL_get_error() inspects the current thread's OpenSSL error queue. Thus, SSL_get_error() must be |