summaryrefslogtreecommitdiff
path: root/ext/socket
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:15:27 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:15:27 +0000
commitd5eef0301a9aa32999c075ea50fd60f0f05e8f73 (patch)
treed74941e52f441350bace15f4144de44201dccd8d /ext/socket
parent2e2063fe16e2549123055f6f8aec5162cef01b99 (diff)
[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 'ext/socket')
-rw-r--r--ext/socket/lib/socket.rb27
1 files changed, 18 insertions, 9 deletions
diff --git a/ext/socket/lib/socket.rb b/ext/socket/lib/socket.rb
index 42c7edd..b02449c 100644
--- a/ext/socket/lib/socket.rb
+++ b/ext/socket/lib/socket.rb
@@ -315,7 +315,8 @@ class BasicSocket < IO
#
# By specifying `exception: false`, the _opts_ hash allows you to indicate
# that sendmsg_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # return the symbol :wait_writable instead. At EOF, it will return nil instead
+ # of raising EOFError.
def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
exception: true)
__sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception)
@@ -363,7 +364,8 @@ class BasicSocket < IO
#
# By specifying `exception: false`, the options hash allows you to indicate
# that recv_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # return the symbol :wait_writable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * Socket#recvfrom
@@ -437,7 +439,8 @@ class BasicSocket < IO
#
# By specifying `exception: false`, the _opts_ hash allows you to indicate
# that recvmsg_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # return the symbol :wait_writable instead. At EOF, it will return nil instead
+ # of raising EOFError.
def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
scm_rights: false, exception: true)
__recvmsg_nonblock(dlen, flags, clen, scm_rights, exception)
@@ -514,7 +517,8 @@ class Socket < BasicSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
- # return the symbol :wait_readable instead.
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * Socket#recvfrom
@@ -571,7 +575,8 @@ class Socket < BasicSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
- # return the symbol :wait_readable instead.
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * Socket#accept
@@ -1190,7 +1195,8 @@ class Socket < BasicSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that connect_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # return the symbol :wait_writable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# # Socket#connect
@@ -1248,7 +1254,8 @@ class UDPSocket < IPSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that recvmsg_nonblock should not raise an IO::WaitWritable exception, but
- # return the symbol :wait_writable instead.
+ # return the symbol :wait_writable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * Socket#recvfrom
@@ -1289,7 +1296,8 @@ class TCPServer < TCPSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
- # return the symbol :wait_readable instead.
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * TCPServer#accept
@@ -1330,7 +1338,8 @@ class UNIXServer < UNIXSocket
#
# By specifying `exception: false`, the options hash allows you to indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
- # return the symbol :wait_readable instead.
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
+ # of raising EOFError.
#
# === See
# * UNIXServer#accept