diff options
Diffstat (limited to 'ext/socket/lib/socket.rb')
| -rw-r--r-- | ext/socket/lib/socket.rb | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/ext/socket/lib/socket.rb b/ext/socket/lib/socket.rb index 42c7edddec..b02449c8e7 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 |