diff options
| author | nobu <nobu@ruby-lang.org> | 2017-02-23 01:15:27 +0000 |
|---|---|---|
| committer | Kazuki Yamaguchi <k@rhe.jp> | 2017-02-24 00:14:49 +0900 |
| commit | 232aaebc35271a6fb6c8420eebdfbde151c4c8bc (patch) | |
| tree | ca201ae2f390e54836103c9bde1756c79b984023 /lib | |
| parent | 09e415d5f102e4f211ca550c4f26dbfa60aef370 (diff) | |
| download | ruby-openssl-232aaebc35271a6fb6c8420eebdfbde151c4c8bc.tar.gz | |
[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 <russell-stripe@users.noreply.github.com>
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57690 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/openssl/buffering.rb | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/openssl/buffering.rb b/lib/openssl/buffering.rb index b0dffefd..30df8197 100644 --- a/lib/openssl/buffering.rb +++ b/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 |