--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: Receives up to maxlen bytes from socket using recvfrom(2) after O_NONBLOCK is set for the underlying file descriptor. flags is zero or more of the MSG_ options. The first element of the results, mesg, is the data received. The second element, sender_sockaddr, contains protocol-specific information on the sender.
- !ruby/struct:SM::Flow::P
body: "When recvfrom(2) returns 0, Socket#recvfrom_nonblock returns an empty string as data. The meaning depends on the socket: EOF on TCP, empty packet on UDP, etc."
- !ruby/struct:SM::Flow::H
level: 3
text: Parameters
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "*"
body: maxlen - the number of bytes to receive from the socket
- !ruby/struct:SM::Flow::LI
label: "*"
body: flags - zero or more of the MSG_ options
type: :BULLET
- !ruby/struct:SM::Flow::H
level: 3
text: Example
- !ruby/struct:SM::Flow::VERB
body: " # In one file, start this first\n require 'socket'\n include Socket::Constants\n socket = Socket.new(AF_INET, SOCK_STREAM, 0)\n sockaddr = Socket.sockaddr_in(2200, 'localhost')\n socket.bind(sockaddr)\n socket.listen(5)\n client, client_sockaddr = socket.accept\n begin\n pair = client.recvfrom_nonblock(20)\n rescue Errno::EAGAIN, Errno::EWOULDBLOCK\n IO.select([client])\n retry\n end\n data = pair[0].chomp\n puts "I only received 20 bytes '#{data}'"\n sleep 1\n socket.close\n\n # In another file, start this second\n require 'socket'\n include Socket::Constants\n socket = Socket.new(AF_INET, SOCK_STREAM, 0)\n sockaddr = Socket.sockaddr_in(2200, 'localhost')\n socket.connect(sockaddr)\n socket.puts "Watch this get cut short!"\n socket.close\n"
- !ruby/struct:SM::Flow::P
body: Refer to Socket#recvfrom for the exceptions that may be thrown if the call to recvfrom_nonblock fails.
- !ruby/struct:SM::Flow::P
body: Socket#recvfrom_nonblock may raise any error corresponding to recvfrom(2) failure, including Errno::EAGAIN.
- !ruby/struct:SM::Flow::H
level: 3
text: See
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "*"
body: Socket#recvfrom
type: :BULLET
full_name: Socket#recvfrom_nonblock
is_singleton: false
name: recvfrom_nonblock
params: |
socket.recvfrom_nonblock(maxlen) => [mesg, sender_sockaddr]
socket.recvfrom_nonblock(maxlen, flags) => [mesg, sender_sockaddr]
visibility: public