From d5eef0301a9aa32999c075ea50fd60f0f05e8f73 Mon Sep 17 00:00:00 2001 From: nobu Date: Thu, 23 Feb 2017 01:15:27 +0000 Subject: [DOC] {read,write}_nonblock with exception: false Update docs to reflect EOF behavior change of read_nonblock and write_nonblock when using `exception: false`. [Fix GH-1527] Author: Russell Davis git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57690 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ext/openssl/lib/openssl/buffering.rb | 6 ++++-- ext/openssl/ossl_ssl.c | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'ext/openssl') diff --git a/ext/openssl/lib/openssl/buffering.rb b/ext/openssl/lib/openssl/buffering.rb index b0dffefd3e..30df819715 100644 --- a/ext/openssl/lib/openssl/buffering.rb +++ b/ext/openssl/lib/openssl/buffering.rb @@ -166,7 +166,8 @@ module OpenSSL::Buffering # # By specifying `exception: false`, the options hash allows you to indicate # that read_nonblock should not raise an IO::Wait*able exception, but - # return the symbol :wait_writable or :wait_readable instead. + # return the symbol :wait_writable or :wait_readable instead. At EOF, it will + # return nil instead of raising EOFError. def read_nonblock(maxlen, buf=nil, exception: true) if maxlen == 0 @@ -378,7 +379,8 @@ module OpenSSL::Buffering # # By specifying `exception: false`, the options hash allows you to indicate # that write_nonblock should not raise an IO::Wait*able exception, but - # return the symbol :wait_writable or :wait_readable instead. + # return the symbol :wait_writable or :wait_readable instead. At EOF, it will + # return nil instead of raising EOFError. def write_nonblock(s, exception: true) flush diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c index eef7dbece6..41d496ff85 100644 --- a/ext/openssl/ossl_ssl.c +++ b/ext/openssl/ossl_ssl.c @@ -1601,7 +1601,7 @@ ossl_ssl_connect(VALUE self) * By specifying `exception: false`, the options hash allows you to indicate * that connect_nonblock should not raise an IO::WaitReadable or * IO::WaitWritable exception, but return the symbol :wait_readable or - * :wait_writable instead. + * :wait_writable instead. At EOF, it will return nil instead of raising EOFError. */ static VALUE ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self) @@ -1649,7 +1649,7 @@ ossl_ssl_accept(VALUE self) * By specifying `exception: false`, the options hash allows you to indicate * that accept_nonblock should not raise an IO::WaitReadable or * IO::WaitWritable exception, but return the symbol :wait_readable or - * :wait_writable instead. + * :wait_writable instead. At EOF, it will return nil instead of raising EOFError. */ static VALUE ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self) -- cgit v1.2.3