summaryrefslogtreecommitdiff
path: root/ext/socket
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:54:13 (GMT)
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-02-23 01:54:13 (GMT)
commit53b4bf3134ba61163f499ae6d87456ecad95506c (patch)
treefabc7d3924cc1849e4d6918d48b2efbbdaf7dfb5 /ext/socket
parentd5eef0301a9aa32999c075ea50fd60f0f05e8f73 (diff)
socket.rb: [DOC] fix nonblock methods
* ext/socket/lib/socket.rb (BasicSocket#recv_nonblock): fix exception class and symbol. * ext/socket/lib/socket.rb (BasicSocket#recvmsg_nonblock): ditto. * ext/socket/lib/socket.rb (Socket#recvfrom_nonblock): fix the method name. * ext/socket/lib/socket.rb (UDPSocket#recvfrom_nonblock): both. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57691 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/socket')
-rw-r--r--ext/socket/lib/socket.rb14
1 files changed, 7 insertions, 7 deletions
diff --git a/ext/socket/lib/socket.rb b/ext/socket/lib/socket.rb
index b02449c..887b334 100644
--- a/ext/socket/lib/socket.rb
+++ b/ext/socket/lib/socket.rb
@@ -363,8 +363,8 @@ class BasicSocket < IO
# So IO::WaitReadable can be used to rescue the exceptions for retrying recv_nonblock.
#
# 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. At EOF, it will return nil instead
+ # that recv_nonblock should not raise an IO::WaitReadable exception, but
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
# of raising EOFError.
#
# === See
@@ -438,8 +438,8 @@ class BasicSocket < IO
# and it doesn't retry the system call.
#
# 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. At EOF, it will return nil instead
+ # that recvmsg_nonblock should not raise an IO::WaitReadable exception, but
+ # return the symbol :wait_readable 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)
@@ -516,7 +516,7 @@ class Socket < BasicSocket
# recvfrom_nonblock.
#
# By specifying `exception: false`, the options hash allows you to indicate
- # that accept_nonblock should not raise an IO::WaitReadable exception, but
+ # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol :wait_readable instead. At EOF, it will return nil instead
# of raising EOFError.
#
@@ -1253,8 +1253,8 @@ class UDPSocket < IPSocket
# So IO::WaitReadable can be used to rescue the exceptions for retrying recvfrom_nonblock.
#
# 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. At EOF, it will return nil instead
+ # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
+ # return the symbol :wait_readable instead. At EOF, it will return nil instead
# of raising EOFError.
#
# === See