Gecko [ primetaxinc.net ]

Name	Size	Permission
Constants	[ DIR ]	drwxr-xr-x
accept-i.yaml	5.59 KB	-rw-r--r--
accept_nonblock-i.yaml	2.12 KB	-rw-r--r--
bind-i.yaml	6.09 KB	-rw-r--r--
cdesc-Socket.yaml	2.29 KB	-rw-r--r--
connect-i.yaml	8.77 KB	-rw-r--r--
connect_nonblock-i.yaml	1.76 KB	-rw-r--r--
getaddrinfo-c.yaml	5.88 KB	-rw-r--r--
gethostbyname-c.yaml	3.81 KB	-rw-r--r--
getservbyname-c.yaml	729 B	-rw-r--r--
listen-i.yaml	5.04 KB	-rw-r--r--
recvfrom-i.yaml	7.38 KB	-rw-r--r--
recvfrom_nonblock-i.yaml	2.66 KB	-rw-r--r--
sysaccept-i.yaml	1.8 KB	-rw-r--r--

Code Editor : listen-i.yaml

--- !ruby/object:RI::MethodDescription 
aliases: []

block_params: 
comment: 
- !ruby/struct:SM::Flow::P 
 body: Listens for connections, using the specified <tt>int</tt> as the backlog. A call to listen only applies if the <tt>socket</tt> is of type SOCK_STREAM or SOCK_SEQPACKET.
- !ruby/struct:SM::Flow::H 
 level: 3
 text: Parameter
- !ruby/object:SM::Flow::LIST 
 contents: 
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: <tt>backlog</tt> - the maximum length of the queue for pending connections.
 type: :BULLET
- !ruby/struct:SM::Flow::H 
 level: 3
 text: Example 1
- !ruby/struct:SM::Flow::VERB 
 body: " require 'socket'\n include Socket::Constants\n socket = Socket.new( AF_INET, SOCK_STREAM, 0 )\n sockaddr = Socket.pack_sockaddr_in( 2200, 'localhost' )\n socket.bind( sockaddr )\n socket.listen( 5 )\n"
- !ruby/struct:SM::Flow::H 
 level: 3
 text: "Example 2 (listening on an arbitary port, unix-based systems only):"
- !ruby/struct:SM::Flow::VERB 
 body: " require 'socket'\n include Socket::Constants\n socket = Socket.new( AF_INET, SOCK_STREAM, 0 )\n socket.listen( 1 )\n"
- !ruby/struct:SM::Flow::H 
 level: 3
 text: Unix-based Exceptions
- !ruby/struct:SM::Flow::P 
 body: On unix based systems the above will work because a new <tt>sockaddr</tt> struct is created on the address ADDR_ANY, for an arbitrary port number as handed off by the kernel. It will not work on Windows, because Windows requires that the <tt>socket</tt> is bound by calling bind before it can listen.
- !ruby/struct:SM::Flow::P 
 body: If the backlog amount exceeds the implementation-dependent maximum queue length, the implementation's maximum queue length will be used.
- !ruby/struct:SM::Flow::P 
 body: "On unix-based based systems the following system exceptions may be raised if the call to listen fails:"
- !ruby/object:SM::Flow::LIST 
 contents: 
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EBADF - the socket argument is not a valid file descriptor
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EDESTADDRREQ - the socket is not bound to a local address, and the protocol does not support listening on an unbound socket
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EINVAL - the socket is already connected
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::ENOTSOCK - the socket argument does not refer to a socket
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EOPNOTSUPP - the socket protocol does not support listen
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EACCES - the calling process does not have approriate privileges
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EINVAL - the socket has been shut down
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::ENOBUFS - insufficient resources are available in the system to complete the call
 type: :BULLET
- !ruby/struct:SM::Flow::H 
 level: 3
 text: Windows Exceptions
- !ruby/struct:SM::Flow::P 
 body: "On Windows systems the following system exceptions may be raised if the call to listen fails:"
- !ruby/object:SM::Flow::LIST 
 contents: 
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::ENETDOWN - the network is down
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EADDRINUSE - the socket's local address is already in use. This usually occurs during the execution of bind but could be delayed if the call to bind was to a partially wildcard address (involving ADDR_ANY) and if a specific address needs to be commmitted at the time of the call to listen
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EINPROGRESS - a Windows Sockets 1.1 call is in progress or the service provider is still processing a callback function
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EINVAL - the <tt>socket</tt> has not been bound with a call to bind.
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EISCONN - the <tt>socket</tt> is already connected
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EMFILE - no more socket descriptors are available
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::ENOBUFS - no buffer space is available
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::ENOTSOC - <tt>socket</tt> is not a socket
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: Errno::EOPNOTSUPP - the referenced <tt>socket</tt> is not a type that supports the listen method
 type: :BULLET
- !ruby/struct:SM::Flow::H 
 level: 3
 text: See
- !ruby/object:SM::Flow::LIST 
 contents: 
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: listen manual pages on unix-based systems
 - !ruby/struct:SM::Flow::LI 
 label: "*"
 body: listen function in Microsoft's Winsock functions reference
 type: :BULLET
full_name: Socket#listen
is_singleton: false
name: listen
params: |
 socket.listen( int ) => 0

visibility: public

${this.title}

Code Editor : listen-i.yaml