rbs 2.0.0 → 2.2.2

data/stdlib/socket/0/socket.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=ext/socket/socket.c -->
 # Class `Socket` provides access to the underlying operating system socket
 # implementations.  It can be used to provide more operating system specific
 # functionality than the protocol-specific socket classes.
@@ -110,7 +111,12 @@
 #
 # Much material in this documentation is taken with permission from *Programming
 # Ruby* from The Pragmatic Bookshelf.
+#
 class Socket < BasicSocket
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - accept_loop(*sockets) { |socket, client_addrinfo| ... }
+  # -->
   # yield socket and client address for each a connection accepted via given
   # sockets.
   #
@@ -123,6 +129,10 @@ class Socket < BasicSocket
   #
   def self.accept_loop: (*_ToIO sockets) { (Socket) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.getaddrinfo(nodename, servname[, family[, socktype[, protocol[, flags[, reverse_lookup]]]]]) => array
+  # -->
   # Obtains address information for *nodename*:*servname*.
   #
   # Note that Addrinfo.getaddrinfo provides the same functionality in an object
@@ -149,13 +159,17 @@ class Socket < BasicSocket
   # below.  If *reverse_lookup* is omitted, the default value is `nil`.
   #
   #     +true+, +:hostname+:  hostname is obtained from numeric address using reverse lookup, which may take a time.
-  #     +false+, +:numeric+:  hostname is same as numeric address.
+  #     +false+, +:numeric+:  hostname is the same as numeric address.
   #     +nil+:              obey to the current +do_not_reverse_lookup+ flag.
   #
   # If Addrinfo object is preferred, use Addrinfo.getaddrinfo.
   #
-  def self.getaddrinfo: (String peer, String | Integer | nil protocol, ?(Integer | Symbol | nil) family, ?(Integer | Symbol | nil) socktype, ?(Integer | Symbol | nil) protocol, ?(Integer | nil) flags) -> [String, Integer, String, String, Integer, Integer, Integer]
+  def self.getaddrinfo: (String peer, String | Integer | nil protocol, ?Integer | Symbol | nil family, ?Integer | Symbol | nil socktype, ?Integer | Symbol | nil protocol, ?Integer | nil flags) -> [ String, Integer, String, String, Integer, Integer, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.gethostbyaddr(address_string [, address_family]) => hostent
+  # -->
   # Use Addrinfo#getnameinfo instead. This method is deprecated for the following
   # reasons:
   #
@@ -177,8 +191,12 @@ class Socket < BasicSocket
   #     #=> ["localhost", ["ip6-localhost", "ip6-loopback"], 10,
   #          "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01"]
   #
-  def self.gethostbyaddr: (String ip) -> [String, Array[String], Integer, String]
+  def self.gethostbyaddr: (String ip) -> [ String, Array[String], Integer, String ]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]
+  # -->
   # Use Addrinfo.getaddrinfo instead. This method is deprecated for the following
   # reasons:
   #
@@ -195,8 +213,12 @@ class Socket < BasicSocket
   #
   #     p Socket.gethostbyname("hal") #=> ["localhost", ["hal"], 2, "\x7F\x00\x00\x01"]
   #
-  def self.gethostbyname: (String name) -> [String, Array[String], Integer, String]
+  def self.gethostbyname: (String name) -> [ String, Array[String], Integer, String ]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.gethostname => hostname
+  # -->
   # Returns the hostname.
   #
   #     p Socket.gethostname #=> "hal"
@@ -207,6 +229,10 @@ class Socket < BasicSocket
   #
   def self.gethostname: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - Socket.getifaddrs => [ifaddr1, ...]
+  # -->
   # Returns an array of interface addresses. An element of the array is an
   # instance of Socket::Ifaddr.
   #
@@ -243,6 +269,10 @@ class Socket < BasicSocket
   #
   def self.getifaddrs: () -> Array[Socket::Ifaddr]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.getnameinfo(sockaddr [, flags]) => [hostname, servicename]
+  # -->
   # Obtains name information for *sockaddr*.
   #
   # *sockaddr* should be one of follows.
@@ -261,9 +291,15 @@ class Socket < BasicSocket
   #
   # If Addrinfo object is preferred, use Addrinfo#getnameinfo.
   #
-  def self.getnameinfo: ([String, Integer, String]) -> Array[String]
-                      | ([String, Integer, String, String]) -> Array[String]
+  def self.getnameinfo: ([ String, Integer, String ]) -> Array[String]
+                      | ([ String, Integer, String, String ]) -> Array[String]
                       | (String sockaddr) -> Array[String]
+
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.getservbyname(service_name)                => port_number
+  #   - Socket.getservbyname(service_name, protocol_name) => port_number
+  # -->
   # Obtains the port number for *service_name*.
   #
   # If *protocol_name* is not given, "tcp" is assumed.
@@ -272,10 +308,13 @@ class Socket < BasicSocket
   #     Socket.getservbyname("shell")         #=> 514
   #     Socket.getservbyname("syslog", "udp") #=> 514
   #
-  #
   def self.getservbyname: (String service_proto) -> Integer
                         | (String service_proto, String layer4_proto) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.getservbyport(port [, protocol_name]) => service
+  # -->
   # Obtains the port number for *port*.
   #
   # If *protocol_name* is not given, "tcp" is assumed.
@@ -287,6 +326,10 @@ class Socket < BasicSocket
   def self.getservbyport: (Integer service_port) -> String
                         | (Integer service_port, String layer4_proto) -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.ip_address_list => array
+  # -->
   # Returns local IP addresses as an array.
   #
   # The array contains Addrinfo objects.
@@ -299,6 +342,11 @@ class Socket < BasicSocket
   #
   def self.ip_address_list: () -> Array[Addrinfo]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.sockaddr_in(port, host)      => sockaddr
+  #   - Socket.pack_sockaddr_in(port, host) => sockaddr
+  # -->
   # Packs *port* and *host* as an AF_INET/AF_INET6 sockaddr string.
   #
   #     Socket.sockaddr_in(80, "127.0.0.1")
@@ -307,16 +355,24 @@ class Socket < BasicSocket
   #     Socket.sockaddr_in(80, "::1")
   #     #=> "\n\x00\x00P\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00"
   #
-  #
   def self.pack_sockaddr_in: (Integer port, String ip) -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.sockaddr_un(path)      => sockaddr
+  #   - Socket.pack_sockaddr_un(path) => sockaddr
+  # -->
   # Packs *path* as an AF_UNIX sockaddr string.
   #
   #     Socket.sockaddr_un("/tmp/sock") #=> "\x01\x00/tmp/sock\x00\x00..."
   #
-  #
   def self.pack_sockaddr_un: (String sockpath) -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.pair(domain, type, protocol)       => [socket1, socket2]
+  #   - Socket.socketpair(domain, type, protocol) => [socket1, socket2]
+  # -->
   # Creates a pair of sockets connected each other.
   #
   # *domain* should be a communications domain such as: :INET, :INET6, :UNIX, etc.
@@ -340,9 +396,13 @@ class Socket < BasicSocket
   #     p s2.recv(10) #=> "a"
   #     p s2.recv(10) #=> "b"
   #
-  #
-  def self.pair: (Symbol sockdomain, Symbol socktype, Integer protocol) -> [instance, instance]
+  def self.pair: (Symbol sockdomain, Symbol socktype, Integer protocol) -> [ instance, instance ]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.sockaddr_in(port, host)      => sockaddr
+  #   - Socket.pack_sockaddr_in(port, host) => sockaddr
+  # -->
   # Packs *port* and *host* as an AF_INET/AF_INET6 sockaddr string.
   #
   #     Socket.sockaddr_in(80, "127.0.0.1")
@@ -351,16 +411,24 @@ class Socket < BasicSocket
   #     Socket.sockaddr_in(80, "::1")
   #     #=> "\n\x00\x00P\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00"
   #
-  #
   def self.sockaddr_in: (Integer port, String ip) -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.sockaddr_un(path)      => sockaddr
+  #   - Socket.pack_sockaddr_un(path) => sockaddr
+  # -->
   # Packs *path* as an AF_UNIX sockaddr string.
   #
   #     Socket.sockaddr_un("/tmp/sock") #=> "\x01\x00/tmp/sock\x00\x00..."
   #
-  #
   def self.sockaddr_un: (String sockpath) -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.pair(domain, type, protocol)       => [socket1, socket2]
+  #   - Socket.socketpair(domain, type, protocol) => [socket1, socket2]
+  # -->
   # Creates a pair of sockets connected each other.
   #
   # *domain* should be a communications domain such as: :INET, :INET6, :UNIX, etc.
@@ -384,9 +452,13 @@ class Socket < BasicSocket
   #     p s2.recv(10) #=> "a"
   #     p s2.recv(10) #=> "b"
   #
-  #
-  def self.socketpair: (Symbol sockdomain, Symbol socktype, Integer protocol) -> [instance, instance]
+  def self.socketpair: (Symbol sockdomain, Symbol socktype, Integer protocol) -> [ instance, instance ]
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - Socket.tcp(host, port, local_host=nil, local_port=nil, [opts]) {|socket| ... }
+  #   - Socket.tcp(host, port, local_host=nil, local_port=nil, [opts])
+  # -->
   # creates a new socket object connected to host:port using TCP/IP.
   #
   # If local_host:local_port is given, the socket is bound to it.
@@ -411,10 +483,13 @@ class Socket < BasicSocket
   #       puts sock.read
   #     }
   #
-  #
   def self.tcp: (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Numeric, ?connect_timeout: Numeric) -> instance
               | (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Numeric, ?connect_timeout: Numeric) { (instance) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - tcp_server_loop(host=nil, port) { |socket, client_addrinfo| ... }
+  # -->
   # creates a TCP/IP server on *port* and calls the block for each connection
   # accepted. The block is called with a socket and a client_address as an
   # Addrinfo object.
@@ -459,6 +534,10 @@ class Socket < BasicSocket
   #
   def self.tcp_server_loop: (?String host, Integer port) { (instance, Addrinfo) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - tcp_server_sockets(host=nil, port) { |sockets| ... }
+  # -->
   # creates TCP/IP server sockets for *host* and *port*. *host* is optional.
   #
   # If no block given, it returns an array of listening sockets.
@@ -492,6 +571,11 @@ class Socket < BasicSocket
   def self.tcp_server_sockets: (?String host, Integer port) -> Array[TCPServer]
                              | (?String host, Integer port) { (Array[TCPServer]) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - Socket.udp_server_loop(port) {|msg, msg_src| ... }
+  #   - Socket.udp_server_loop(host, port) {|msg, msg_src| ... }
+  # -->
   # creates a UDP/IP server on *port* and calls the block for each message
   # arrived. The block is called with the message and its source information.
   #
@@ -507,9 +591,12 @@ class Socket < BasicSocket
   #       msg_src.reply msg
   #     }
   #
-  #
   def self.udp_server_loop: (?String host, Integer port) { (String, Socket::UDPSource) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - Socket.udp_server_loop_on(sockets) {|msg, msg_src| ... }
+  # -->
   # Run UDP/IP server loop on the given sockets.
   #
   # The return value of Socket.udp_server_sockets is appropriate for the argument.
@@ -518,6 +605,10 @@ class Socket < BasicSocket
   #
   def self.udp_server_loop_on: (UDPSocket sockets) { (String, Socket::UDPSource) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - Socket.udp_server_recv(sockets) {|msg, msg_src| ... }
+  # -->
   # Receive UDP/IP packets from the given *sockets*. For each packet received, the
   # block is called.
   #
@@ -536,6 +627,10 @@ class Socket < BasicSocket
   #
   def self.udp_server_recv: (Array[UDPSocket] sockets) { (String, Socket::UDPSource) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - Socket.udp_server_sockets([host, ] port)
+  # -->
   # Creates UDP/IP sockets for a UDP server.
   #
   # If no block given, it returns an array of sockets.
@@ -556,6 +651,10 @@ class Socket < BasicSocket
   #
   def self.udp_server_sockets: (?String host, Integer port) { (UDPSocket) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - unix(path) { |socket| ... }
+  # -->
   # creates a new socket connected to path using UNIX socket socket.
   #
   # If a block is given, the block is called with the socket. The value of the
@@ -573,6 +672,10 @@ class Socket < BasicSocket
   def self.unix: (String path) -> UNIXSocket
                | (String path) { (UNIXSocket) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - unix_server_loop(path) { |socket, client_addrinfo| ... }
+  # -->
   # creates a UNIX socket server on *path*. It calls the block for each socket
   # accepted.
   #
@@ -599,6 +702,10 @@ class Socket < BasicSocket
   #
   def self.unix_server_loop: (String path) { (UNIXSocket, Addrinfo) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - unix_server_socket(path) { |s| ... }
+  # -->
   # creates a UNIX server socket on *path*
   #
   # If no block given, it returns a listening socket.
@@ -619,6 +726,10 @@ class Socket < BasicSocket
   def self.unix_server_socket: (String path) -> Socket
                              | (String path) { (Socket) -> void } -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.unpack_sockaddr_in(sockaddr) => [port, ip_address]
+  # -->
   # Unpacks *sockaddr* into port and ip_address.
   #
   # *sockaddr* should be a string or an addrinfo for AF_INET/AF_INET6.
@@ -627,8 +738,12 @@ class Socket < BasicSocket
   #     p sockaddr #=> "\x02\x00\x00P\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
   #     p Socket.unpack_sockaddr_in(sockaddr) #=> [80, "127.0.0.1"]
   #
-  def self.unpack_sockaddr_in: (String | Addrinfo sockaddr) -> [Integer, String]
+  def self.unpack_sockaddr_in: (String | Addrinfo sockaddr) -> [ Integer, String ]
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.unpack_sockaddr_un(sockaddr) => path
+  # -->
   # Unpacks *sockaddr* into path.
   #
   # *sockaddr* should be a string or an addrinfo for AF_UNIX.
@@ -640,6 +755,10 @@ class Socket < BasicSocket
 
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.accept => [client_socket, client_addrinfo]
+  # -->
   # Accepts a next connection. Returns a new Socket object and Addrinfo object.
   #
   #     serv = Socket.new(:INET, :STREAM, 0)
@@ -648,8 +767,12 @@ class Socket < BasicSocket
   #     c.connect(serv.connect_address)
   #     p serv.accept #=> [#<Socket:fd 6>, #<Addrinfo: 127.0.0.1:48555 TCP>]
   #
-  def accept: () -> [Socket, Addrinfo]
+  def accept: () -> [ Socket, Addrinfo ]
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - socket.accept_nonblock([options]) => [client_socket, client_addrinfo]
+  # -->
   # Accepts an incoming connection using accept(2) after O_NONBLOCK is set for the
   # underlying file descriptor. It returns an array containing the accepted socket
   # for the incoming connection, *client_socket*, and an Addrinfo,
@@ -700,9 +823,12 @@ class Socket < BasicSocket
   # ### See
   # *   Socket#accept
   #
-  #
-  def accept_nonblock: (?exception: boolish) -> ([Socket, Addrinfo] | :wait_readable)
+  def accept_nonblock: (?exception: boolish) -> ([ Socket, Addrinfo ] | :wait_readable)
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.bind(local_sockaddr) => 0
+  # -->
   # Binds to the given local address.
   #
   # ### Parameter
@@ -790,9 +916,12 @@ class Socket < BasicSocket
   # *   bind manual pages on unix-based systems
   # *   bind function in Microsoft's Winsock functions reference
   #
-  #
   def bind: (String | Addrinfo local_sockaddr) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.connect(remote_sockaddr) => 0
+  # -->
   # Requests a connection to be made on the given `remote_sockaddr`. Returns 0 if
   # successful, otherwise an exception is raised.
   #
@@ -852,8 +981,8 @@ class Socket < BasicSocket
   #     connected
   # *   Errno::EPROTOTYPE - the *sockaddr* has a different type than the socket
   #     bound to the specified peer address
-  # *   Errno::ETIMEDOUT - the attempt to connect time out before a connection was
-  #     made.
+  # *   Errno::ETIMEDOUT - the attempt to connect timed out before a connection
+  #     was made.
   #
   #
   # On unix-based systems if the address family of the calling `socket` is AF_UNIX
@@ -895,8 +1024,8 @@ class Socket < BasicSocket
   # *   Errno::EHOSTUNREACH - no route to the network is present
   # *   Errno::ENOBUFS - no buffer space is available
   # *   Errno::ENOTSOCK - the `socket` argument does not refer to a socket
-  # *   Errno::ETIMEDOUT - the attempt to connect time out before a connection was
-  #     made.
+  # *   Errno::ETIMEDOUT - the attempt to connect timed out before a connection
+  #     was made.
   # *   Errno::EWOULDBLOCK - the socket is marked as nonblocking and the
   #     connection cannot be completed immediately
   # *   Errno::EACCES - the attempt to connect the datagram socket to the
@@ -907,9 +1036,12 @@ class Socket < BasicSocket
   # *   connect manual pages on unix-based systems
   # *   connect function in Microsoft's Winsock functions reference
   #
-  #
   def connect: (String | Addrinfo remote_sockaddr) -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - socket.connect_nonblock(remote_sockaddr, [options]) => 0
+  # -->
   # Requests a connection to be made on the given `remote_sockaddr` after
   # O_NONBLOCK is set for the underlying file descriptor. Returns 0 if successful,
   # otherwise an exception is raised.
@@ -954,10 +1086,18 @@ class Socket < BasicSocket
   #
   def connect_nonblock: (untyped addr, ?exception: untyped) -> (Integer | :wait_writable)
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - ipv6only!()
+  # -->
   # enable the socket option IPV6_V6ONLY if IPV6_V6ONLY is available.
   #
   def ipv6only!: () -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.listen( int ) => 0
+  # -->
   # Listens for connections, using the specified `int` as the backlog. A call to
   # *listen* only applies if the `socket` is of type SOCK_STREAM or
   # SOCK_SEQPACKET.
@@ -1027,9 +1167,13 @@ class Socket < BasicSocket
   # *   listen manual pages on unix-based systems
   # *   listen function in Microsoft's Winsock functions reference
   #
-  #
   def listen: (Integer backlog_len) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.recvfrom(maxlen) => [mesg, sender_addrinfo]
+  #   - socket.recvfrom(maxlen, flags) => [mesg, sender_addrinfo]
+  # -->
   # Receives up to *maxlen* bytes from `socket`. *flags* is zero or more of the
   # `MSG_` options. The first element of the results, *mesg*, is the data
   # received. The second element, *sender_addrinfo*, contains protocol-specific
@@ -1134,10 +1278,12 @@ class Socket < BasicSocket
   #     indicates a previous send operation resulted in an ICMP Port Unreachable
   #     message.
   #
-  #
-  #
-  def recvfrom: (Integer maxlen, ?Integer flags) -> [String, Addrinfo]
+  def recvfrom: (Integer maxlen, ?Integer flags) -> [ String, Addrinfo ]
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - socket.recvfrom_nonblock(maxlen[, flags[, outbuf[, opts]]]) => [mesg, sender_addrinfo]
+  # -->
   # 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
@@ -1201,9 +1347,12 @@ class Socket < BasicSocket
   # ### See
   # *   Socket#recvfrom
   #
-  #
-  def recvfrom_nonblock: (Integer maxlen, ?Integer flags, ?untyped outbuf, ?exception: boolish) -> ([String, Addrinfo] | :wait_readable)
+  def recvfrom_nonblock: (Integer maxlen, ?Integer flags, ?untyped outbuf, ?exception: boolish) -> ([ String, Addrinfo ] | :wait_readable)
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - socket.sysaccept => [client_socket_fd, client_addrinfo]
+  # -->
   # Accepts an incoming connection returning an array containing the (integer)
   # file descriptor for the incoming connection, *client_socket_fd*, and an
   # Addrinfo, *client_addrinfo*.
@@ -1238,8 +1387,7 @@ class Socket < BasicSocket
   # ### See
   # *   Socket#accept
   #
-  #
-  def sysaccept: () -> [Integer, Addrinfo]
+  def sysaccept: () -> [ Integer, Addrinfo ]
 
   private
 
@@ -1249,6 +1397,10 @@ class Socket < BasicSocket
 
   def __recvfrom_nonblock: (untyped, untyped, untyped, untyped) -> untyped
 
+  # <!--
+  #   rdoc-file=ext/socket/socket.c
+  #   - Socket.new(domain, socktype [, protocol]) => socket
+  # -->
   # Creates a new socket object.
   #
   # *domain* should be a communications domain such as: :INET, :INET6, :UNIX, etc.
@@ -1266,1174 +1418,1496 @@ class Socket < BasicSocket
   def initialize: (Symbol domain, Symbol socktype, ?Integer protocol) -> untyped
 end
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # AppleTalk protocol
 #
 Socket::AF_APPLETALK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # CCITT (now ITU-T) protocols
 #
 Socket::AF_CCITT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # MIT CHAOS protocols
 #
 Socket::AF_CHAOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Computer Network Technology
 #
 Socket::AF_CNT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Connection-oriented IP
 #
 Socket::AF_COIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Datakit protocol
 #
 Socket::AF_DATAKIT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # DEC Direct Data Link Interface protocol
 #
 Socket::AF_DLI: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # CCITT (ITU-T) E.164 recommendation
 #
 Socket::AF_E164: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # European Computer Manufacturers protocols
 #
 Socket::AF_ECMA: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # NSC Hyperchannel protocol
 #
 Socket::AF_HYLINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ARPANET IMP protocol
 #
 Socket::AF_IMPLINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPv4 protocol
 #
 Socket::AF_INET: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPv6 protocol
 #
 Socket::AF_INET6: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPX protocol
 #
 Socket::AF_IPX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Integrated Services Digital Network
 #
 Socket::AF_ISDN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO Open Systems Interconnection protocols
 #
 Socket::AF_ISO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Local Area Transport protocol
 #
 Socket::AF_LAT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Link layer interface
 #
 Socket::AF_LINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Host-internal protocols
 #
 Socket::AF_LOCAL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum address family for this platform
 #
 Socket::AF_MAX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Native ATM access
 #
 Socket::AF_NATM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Network driver raw access
 #
 Socket::AF_NDRV: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # NetBIOS
 #
 Socket::AF_NETBIOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # XEROX NS protocols
 #
 Socket::AF_NS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO Open Systems Interconnection protocols
 #
 Socket::AF_OSI: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Point-to-Point Protocol
 #
 Socket::AF_PPP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # PARC Universal Packet protocol
 #
 Socket::AF_PUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Internal routing protocol
 #
 Socket::AF_ROUTE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Simple Internet Protocol
 #
 Socket::AF_SIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IBM SNA protocol
 #
 Socket::AF_SNA: Integer
 
 Socket::AF_SYSTEM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # UNIX sockets
 #
 Socket::AF_UNIX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Unspecified protocol, any supported address family
 #
 Socket::AF_UNSPEC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Accept only if any address is assigned
 #
 Socket::AI_ADDRCONFIG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Allow all addresses
 #
 Socket::AI_ALL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Fill in the canonical name
 #
 Socket::AI_CANONNAME: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Default flags for getaddrinfo
 #
 Socket::AI_DEFAULT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Valid flag mask for getaddrinfo (not for application use)
 #
 Socket::AI_MASK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Prevent host name resolution
 #
 Socket::AI_NUMERICHOST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Prevent service name resolution
 #
 Socket::AI_NUMERICSERV: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Get address to use with bind()
 #
 Socket::AI_PASSIVE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Accept IPv4-mapped IPv6 addresses
 #
 Socket::AI_V4MAPPED: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Accept IPv4 mapped addresses if the kernel supports it
 #
 Socket::AI_V4MAPPED_CFG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Address family for hostname not supported
 #
 Socket::EAI_ADDRFAMILY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Temporary failure in name resolution
 #
 Socket::EAI_AGAIN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Invalid flags
 #
 Socket::EAI_BADFLAGS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Invalid value for hints
 #
 Socket::EAI_BADHINTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Non-recoverable failure in name resolution
 #
 Socket::EAI_FAIL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Address family not supported
 #
 Socket::EAI_FAMILY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum error code from getaddrinfo
 #
 Socket::EAI_MAX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Memory allocation failure
 #
 Socket::EAI_MEMORY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # No address associated with hostname
 #
 Socket::EAI_NODATA: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Hostname nor servname, or not known
 #
 Socket::EAI_NONAME: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Argument buffer overflow
 #
 Socket::EAI_OVERFLOW: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Resolved protocol is unknown
 #
 Socket::EAI_PROTOCOL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Servname not supported for socket type
 #
 Socket::EAI_SERVICE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Socket type not supported
 #
 Socket::EAI_SOCKTYPE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # System error returned in errno
 #
 Socket::EAI_SYSTEM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # receive all multicast packets
 #
 Socket::IFF_ALLMULTI: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # use alternate physical connection
 #
 Socket::IFF_ALTPHYS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # broadcast address valid
 #
 Socket::IFF_BROADCAST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # turn on debugging
 #
 Socket::IFF_DEBUG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # per link layer defined bit 0
 #
 Socket::IFF_LINK0: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # per link layer defined bit 1
 #
 Socket::IFF_LINK1: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # per link layer defined bit 2
 #
 Socket::IFF_LINK2: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # loopback net
 #
 Socket::IFF_LOOPBACK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # supports multicast
 #
 Socket::IFF_MULTICAST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # no address resolution protocol
 #
 Socket::IFF_NOARP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # avoid use of trailers
 #
 Socket::IFF_NOTRAILERS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # transmission in progress
 #
 Socket::IFF_OACTIVE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # point-to-point link
 #
 Socket::IFF_POINTOPOINT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # receive all packets
 #
 Socket::IFF_PROMISC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # resources allocated
 #
 Socket::IFF_RUNNING: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # can't hear own transmissions
 #
 Socket::IFF_SIMPLEX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # interface is up
 #
 Socket::IFF_UP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum interface name size
 #
 Socket::IFNAMSIZ: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum interface name size
 #
 Socket::IF_NAMESIZE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Multicast group for all systems on this subset
 #
 Socket::INADDR_ALLHOSTS_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A socket bound to INADDR_ANY receives packets from all interfaces and sends
 # from the default IP address
 #
 Socket::INADDR_ANY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # The network broadcast address
 #
 Socket::INADDR_BROADCAST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # The loopback address
 #
 Socket::INADDR_LOOPBACK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # The last local network multicast group
 #
 Socket::INADDR_MAX_LOCAL_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A bitmask for matching no valid IP address
 #
 Socket::INADDR_NONE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # The reserved multicast group
 #
 Socket::INADDR_UNSPEC_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum length of an IPv6 address string
 #
 Socket::INET6_ADDRSTRLEN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum length of an IPv4 address string
 #
 Socket::INET_ADDRSTRLEN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Default minimum address for bind or connect
 #
 Socket::IPPORT_RESERVED: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Default maximum address for bind or connect
 #
 Socket::IPPORT_USERRESERVED: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 auth header
 #
 Socket::IPPROTO_AH: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 destination option
 #
 Socket::IPPROTO_DSTOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Exterior Gateway Protocol
 #
 Socket::IPPROTO_EGP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO cnlp
 #
 Socket::IPPROTO_EON: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 Encapsulated Security Payload
 #
 Socket::IPPROTO_ESP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 fragmentation header
 #
 Socket::IPPROTO_FRAGMENT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Gateway to Gateway Protocol
 #
 Socket::IPPROTO_GGP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # "hello" routing protocol
 #
 Socket::IPPROTO_HELLO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 hop-by-hop options
 #
 Socket::IPPROTO_HOPOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Control message protocol
 #
 Socket::IPPROTO_ICMP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ICMP6
 #
 Socket::IPPROTO_ICMPV6: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # XNS IDP
 #
 Socket::IPPROTO_IDP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Group Management Protocol
 #
 Socket::IPPROTO_IGMP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Dummy protocol for IP
 #
 Socket::IPPROTO_IP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 header
 #
 Socket::IPPROTO_IPV6: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum IPPROTO constant
 #
 Socket::IPPROTO_MAX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Sun net disk protocol
 #
 Socket::IPPROTO_ND: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 no next header
 #
 Socket::IPPROTO_NONE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # PARC Universal Packet protocol
 #
 Socket::IPPROTO_PUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Raw IP packet
 #
 Socket::IPPROTO_RAW: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 routing header
 #
 Socket::IPPROTO_ROUTING: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # TCP
 #
 Socket::IPPROTO_TCP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO transport protocol class 4
 #
 Socket::IPPROTO_TP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # UDP
 #
 Socket::IPPROTO_UDP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Xpress Transport Protocol
 #
 Socket::IPPROTO_XTP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Checksum offset for raw sockets
 #
 Socket::IPV6_CHECKSUM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Don't fragment packets
 #
 Socket::IPV6_DONTFRAG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Destination option
 #
 Socket::IPV6_DSTOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Hop limit
 #
 Socket::IPV6_HOPLIMIT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Hop-by-hop option
 #
 Socket::IPV6_HOPOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Join a group membership
 #
 Socket::IPV6_JOIN_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Leave a group membership
 #
 Socket::IPV6_LEAVE_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 multicast hops
 #
 Socket::IPV6_MULTICAST_HOPS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 multicast interface
 #
 Socket::IPV6_MULTICAST_IF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 multicast loopback
 #
 Socket::IPV6_MULTICAST_LOOP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Next hop address
 #
 Socket::IPV6_NEXTHOP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Retrieve current path MTU
 #
 Socket::IPV6_PATHMTU: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive packet information with datagram
 #
 Socket::IPV6_PKTINFO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive all IP6 options for response
 #
 Socket::IPV6_RECVDSTOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive hop limit with datagram
 #
 Socket::IPV6_RECVHOPLIMIT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive hop-by-hop options
 #
 Socket::IPV6_RECVHOPOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive current path MTU with datagram
 #
 Socket::IPV6_RECVPATHMTU: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive destination IP address and incoming interface
 #
 Socket::IPV6_RECVPKTINFO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive routing header
 #
 Socket::IPV6_RECVRTHDR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive traffic class
 #
 Socket::IPV6_RECVTCLASS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Allows removal of sticky routing headers
 #
 Socket::IPV6_RTHDR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Allows removal of sticky destination options header
 #
 Socket::IPV6_RTHDRDSTOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Routing header type 0
 #
 Socket::IPV6_RTHDR_TYPE_0: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Specify the traffic class
 #
 Socket::IPV6_TCLASS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP6 unicast hops
 #
 Socket::IPV6_UNICAST_HOPS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Use the minimum MTU size
 #
 Socket::IPV6_USE_MIN_MTU: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Only bind IPv6 with a wildcard bind
 #
 Socket::IPV6_V6ONLY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Add a multicast group membership
 #
 Socket::IP_ADD_MEMBERSHIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Add a multicast group membership
 #
 Socket::IP_ADD_SOURCE_MEMBERSHIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Block IPv4 multicast packets with a give source address
 #
 Socket::IP_BLOCK_SOURCE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Default multicast loopback
 #
 Socket::IP_DEFAULT_MULTICAST_LOOP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Default multicast TTL
 #
 Socket::IP_DEFAULT_MULTICAST_TTL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Drop a multicast group membership
 #
 Socket::IP_DROP_MEMBERSHIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Drop a multicast group membership
 #
 Socket::IP_DROP_SOURCE_MEMBERSHIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Header is included with data
 #
 Socket::IP_HDRINCL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPsec security policy
 #
 Socket::IP_IPSEC_POLICY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum number multicast groups a socket can join
 #
 Socket::IP_MAX_MEMBERSHIPS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Multicast source filtering
 #
 Socket::IP_MSFILTER: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP multicast interface
 #
 Socket::IP_MULTICAST_IF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP multicast loopback
 #
 Socket::IP_MULTICAST_LOOP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP multicast TTL
 #
 Socket::IP_MULTICAST_TTL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP options to be included in packets
 #
 Socket::IP_OPTIONS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive packet information with datagrams
 #
 Socket::IP_PKTINFO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Set the port range for sockets with unspecified port numbers
 #
 Socket::IP_PORTRANGE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive IP destination address with datagram
 #
 Socket::IP_RECVDSTADDR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive interface information with datagrams
 #
 Socket::IP_RECVIF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive all IP options with datagram
 #
 Socket::IP_RECVOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive all IP options for response
 #
 Socket::IP_RECVRETOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive TOS with incoming packets
 #
 Socket::IP_RECVTOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive IP TTL with datagrams
 #
 Socket::IP_RECVTTL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP options to be included in datagrams
 #
 Socket::IP_RETOPTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP type-of-service
 #
 Socket::IP_TOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IP time-to-live
 #
 Socket::IP_TTL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Unblock IPv4 multicast packets with a give source address
 #
 Socket::IP_UNBLOCK_SOURCE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Retrieve peer credentials
 #
 Socket::LOCAL_PEERCRED: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Block multicast packets from this source
 #
 Socket::MCAST_BLOCK_SOURCE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Exclusive multicast source filter
 #
 Socket::MCAST_EXCLUDE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Inclusive multicast source filter
 #
 Socket::MCAST_INCLUDE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Join a multicast group
 #
 Socket::MCAST_JOIN_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Join a multicast source group
 #
 Socket::MCAST_JOIN_SOURCE_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Leave a multicast group
 #
 Socket::MCAST_LEAVE_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Leave a multicast source group
 #
 Socket::MCAST_LEAVE_SOURCE_GROUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Unblock multicast packets from this source
 #
 Socket::MCAST_UNBLOCK_SOURCE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Control data lost before delivery
 #
 Socket::MSG_CTRUNC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Send without using the routing tables
 #
 Socket::MSG_DONTROUTE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # This message should be non-blocking
 #
 Socket::MSG_DONTWAIT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Data completes connection
 #
 Socket::MSG_EOF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Data completes record
 #
 Socket::MSG_EOR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Start of a hold sequence.  Dumps to so_temp
 #
 Socket::MSG_FLUSH: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Data ready to be read
 #
 Socket::MSG_HAVEMORE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Hold fragment in so_temp
 #
 Socket::MSG_HOLD: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Process out-of-band data
 #
 Socket::MSG_OOB: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Peek at incoming message
 #
 Socket::MSG_PEEK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Data remains in the current packet
 #
 Socket::MSG_RCVMORE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Send the packet in so_temp
 #
 Socket::MSG_SEND: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Data discarded before delivery
 #
 Socket::MSG_TRUNC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Wait for full request or error
 #
 Socket::MSG_WAITALL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # The service specified is a datagram service (looks up UDP ports)
 #
 Socket::NI_DGRAM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum length of a hostname
 #
 Socket::NI_MAXHOST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum length of a service name
 #
 Socket::NI_MAXSERV: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A name is required
 #
 Socket::NI_NAMEREQD: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # An FQDN is not required for local hosts, return only the local part
 #
 Socket::NI_NOFQDN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Return a numeric address
 #
 Socket::NI_NUMERICHOST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Return the service name as a digit string
 #
 Socket::NI_NUMERICSERV: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # AppleTalk protocol
 #
 Socket::PF_APPLETALK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # CCITT (now ITU-T) protocols
 #
 Socket::PF_CCITT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # MIT CHAOS protocols
 #
 Socket::PF_CHAOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Computer Network Technology
 #
 Socket::PF_CNT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Connection-oriented IP
 #
 Socket::PF_COIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Datakit protocol
 #
 Socket::PF_DATAKIT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # DEC Direct Data Link Interface protocol
 #
 Socket::PF_DLI: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # European Computer Manufacturers protocols
 #
 Socket::PF_ECMA: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # NSC Hyperchannel protocol
 #
 Socket::PF_HYLINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ARPANET IMP protocol
 #
 Socket::PF_IMPLINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPv4 protocol
 #
 Socket::PF_INET: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPv6 protocol
 #
 Socket::PF_INET6: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IPX protocol
 #
 Socket::PF_IPX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Integrated Services Digital Network
 #
 Socket::PF_ISDN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO Open Systems Interconnection protocols
 #
 Socket::PF_ISO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
+# Key management protocol, originally developed for usage with IPsec
+#
 Socket::PF_KEY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Local Area Transport protocol
 #
 Socket::PF_LAT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Link layer interface
 #
 Socket::PF_LINK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Host-internal protocols
 #
 Socket::PF_LOCAL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum address family for this platform
 #
 Socket::PF_MAX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Native ATM access
 #
 Socket::PF_NATM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Network driver raw access
 #
 Socket::PF_NDRV: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # NetBIOS
 #
 Socket::PF_NETBIOS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # XEROX NS protocols
 #
 Socket::PF_NS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # ISO Open Systems Interconnection protocols
 #
 Socket::PF_OSI: Integer
 
 Socket::PF_PIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Point-to-Point Protocol
 #
 Socket::PF_PPP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # PARC Universal Packet protocol
 #
 Socket::PF_PUP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Internal routing protocol
 #
 Socket::PF_ROUTE: Integer
 
 Socket::PF_RTIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Simple Internet Protocol
 #
 Socket::PF_SIP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # IBM SNA protocol
 #
 Socket::PF_SNA: Integer
 
 Socket::PF_SYSTEM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # UNIX sockets
 #
 Socket::PF_UNIX: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Unspecified protocol, any supported address family
 #
 Socket::PF_UNSPEC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # eXpress Transfer Protocol
 #
 Socket::PF_XTP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Process credentials
 #
 Socket::SCM_CREDS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Access rights
 #
 Socket::SCM_RIGHTS: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Timestamp (timeval)
 #
 Socket::SCM_TIMESTAMP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Shut down the reading side of the socket
 #
 Socket::SHUT_RD: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Shut down the both sides of the socket
 #
 Socket::SHUT_RDWR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Shut down the writing side of the socket
 #
 Socket::SHUT_WR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A datagram socket provides connectionless, unreliable messaging
 #
 Socket::SOCK_DGRAM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A raw socket provides low-level access for direct access or implementing
 # network protocols
 #
 Socket::SOCK_RAW: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A reliable datagram socket provides reliable delivery of messages
 #
 Socket::SOCK_RDM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A sequential packet socket provides sequenced, reliable two-way connection for
 # datagrams
 #
 Socket::SOCK_SEQPACKET: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # A stream socket provides a sequenced, reliable two-way connection for a byte
 # stream
 #
 Socket::SOCK_STREAM: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Socket-level options
 #
 Socket::SOL_SOCKET: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum connection requests that may be queued for a socket
 #
 Socket::SOMAXCONN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Socket has had listen() called on it
 #
 Socket::SO_ACCEPTCONN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Permit sending of broadcast messages
 #
 Socket::SO_BROADCAST: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Debug info recording
 #
 Socket::SO_DEBUG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Use interface addresses
 #
 Socket::SO_DONTROUTE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Retain unread data
 #
 Socket::SO_DONTTRUNC: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Get and clear the error status
 #
 Socket::SO_ERROR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Keep connections alive
 #
 Socket::SO_KEEPALIVE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Linger on close if data is present
 #
 Socket::SO_LINGER: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Install socket-level Network Kernel Extension
 #
 Socket::SO_NKE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Don't SIGPIPE on EPIPE
 #
 Socket::SO_NOSIGPIPE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Get first packet byte count
 #
 Socket::SO_NREAD: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Leave received out-of-band data in-line
 #
 Socket::SO_OOBINLINE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive buffer size
 #
 Socket::SO_RCVBUF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive low-water mark
 #
 Socket::SO_RCVLOWAT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive timeout
 #
 Socket::SO_RCVTIMEO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Allow local address reuse
 #
 Socket::SO_REUSEADDR: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Allow local address and port reuse
 #
 Socket::SO_REUSEPORT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Send buffer size
 #
 Socket::SO_SNDBUF: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Send low-water mark
 #
 Socket::SO_SNDLOWAT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Send timeout
 #
 Socket::SO_SNDTIMEO: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Receive timestamp with datagrams (timeval)
 #
 Socket::SO_TIMESTAMP: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Get the socket type
 #
 Socket::SO_TYPE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Bypass hardware when possible
 #
 Socket::SO_USELOOPBACK: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Give a hint when more data is ready
 #
 Socket::SO_WANTMORE: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # OOB data is wanted in MSG_FLAG on receive
 #
 Socket::SO_WANTOOBFLAG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Reduce step of the handshake process (Linux 3.7, glibc 2.18)
 #
 Socket::TCP_FASTOPEN: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Maximum number of keepalive probes allowed before dropping a connection (Linux
 # 2.4, glibc 2.2)
 #
 Socket::TCP_KEEPCNT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Time between keepalive probes (Linux 2.4, glibc 2.2)
 #
 Socket::TCP_KEEPINTVL: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Set maximum segment size
 #
 Socket::TCP_MAXSEG: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Don't delay sending to coalesce packets
 #
 Socket::TCP_NODELAY: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Don't use TCP options
 #
 Socket::TCP_NOOPT: Integer
 
+# <!-- rdoc-file=ext/socket/constdefs.c -->
 # Don't push the last block of write
 #
 Socket::TCP_NOPUSH: Integer
 
+# <!-- rdoc-file=ext/socket/ifaddr.c -->
 # Socket::Ifaddr represents a result of getifaddrs() function.
+#
 class Socket::Ifaddr
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.addr => addrinfo
+  # -->
   # Returns the address of *ifaddr*. nil is returned if address is not available
   # in *ifaddr*.
   #
   def addr: () -> Addrinfo?
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.broadaddr => addrinfo
+  # -->
   # Returns the broadcast address of *ifaddr*. nil is returned if the flags
   # doesn't have IFF_BROADCAST.
   #
   def broadaddr: () -> Addrinfo?
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.dstaddr => addrinfo
+  # -->
   # Returns the destination address of *ifaddr*. nil is returned if the flags
   # doesn't have IFF_POINTOPOINT.
   #
   def dstaddr: () -> Addrinfo?
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.flags => integer
+  # -->
   # Returns the flags of *ifaddr*.
   #
   def flags: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.ifindex => integer
+  # -->
   # Returns the interface index of *ifaddr*.
   #
   def ifindex: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.inspect => string
+  # -->
   # Returns a string to show contents of *ifaddr*.
   #
   def inspect: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.name => string
+  # -->
   # Returns the interface name of *ifaddr*.
   #
   def name: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/ifaddr.c
+  #   - ifaddr.netmask => addrinfo
+  # -->
   # Returns the netmask address of *ifaddr*. nil is returned if netmask is not
   # available in *ifaddr*.
   #
   def netmask: () -> Addrinfo?
 end
 
+# <!-- rdoc-file=ext/socket/lib/socket.rb -->
 # UDP/IP address information used by Socket.udp_server_loop.
+#
 class Socket::UDPSource
   public
 
   def inspect: () -> String
 
+  # <!-- rdoc-file=ext/socket/lib/socket.rb -->
   # Local address
   #
   def local_address: () -> Addrinfo
 
+  # <!-- rdoc-file=ext/socket/lib/socket.rb -->
   # Address of the source
   #
   def remote_address: () -> Addrinfo
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - reply(msg)
+  # -->
   # Sends the String `msg` to the source
   #
   def reply: (String msg) -> void
 
   private
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - new(remote_address, local_address, &reply_proc)
+  # -->
   # `remote_address` is an Addrinfo object.
   #
   # `local_address` is an Addrinfo object.
@@ -2443,10 +2917,16 @@ class Socket::UDPSource
   def initialize: (Addrinfo remote_address, Addrinfo local_address) { (String) -> void } -> void
 end
 
+# <!-- rdoc-file=ext/socket/ancdata.c -->
 # Socket::AncillaryData represents the ancillary data (control information) used
 # by sendmsg and recvmsg system call.  It contains socket #family, control
 # message (cmsg) #level, cmsg #type and cmsg #data.
+#
 class Socket::AncillaryData
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - Socket::AncillaryData.int(family, cmsg_level, cmsg_type, integer) => ancillarydata
+  # -->
   # Creates a new Socket::AncillaryData object which contains a int as data.
   #
   # The size and endian is dependent on the host.
@@ -2458,6 +2938,11 @@ class Socket::AncillaryData
   #
   def self.int: (Symbol, Symbol, Symbol, Symbol) -> instance
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - Socket::AncillaryData.ip_pktinfo(addr, ifindex) => ancdata
+  #   - Socket::AncillaryData.ip_pktinfo(addr, ifindex, spec_dst) => ancdata
+  # -->
   # Returns new ancillary data for IP_PKTINFO.
   #
   # If spec_dst is not given, addr is used.
@@ -2474,6 +2959,10 @@ class Socket::AncillaryData
   #
   def self.ip_pktinfo: (Addrinfo addr, Integer ifindex, ?Addrinfo spec_dst) -> instance
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - Socket::AncillaryData.ipv6_pktinfo(addr, ifindex) => ancdata
+  # -->
   # Returns new ancillary data for IPV6_PKTINFO.
   #
   # IPV6_PKTINFO is defined by RFC 3542.
@@ -2485,6 +2974,10 @@ class Socket::AncillaryData
   #
   def self.ipv6_pktinfo: (Addrinfo addr, Integer ifindex) -> instance
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - Socket::AncillaryData.unix_rights(io1, io2, ...) => ancillarydata
+  # -->
   # Creates a new Socket::AncillaryData object which contains file descriptors as
   # data.
   #
@@ -2495,6 +2988,10 @@ class Socket::AncillaryData
 
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.cmsg_is?(level, type) => true or false
+  # -->
   # tests the level and type of *ancillarydata*.
   #
   #     ancdata = Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "")
@@ -2505,6 +3002,10 @@ class Socket::AncillaryData
   #
   def cmsg_is?: (Integer level, Integer ancillary_type) -> bool
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.data => string
+  # -->
   # returns the cmsg data as a string.
   #
   #     p Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "").data
@@ -2512,6 +3013,10 @@ class Socket::AncillaryData
   #
   def data: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.family => integer
+  # -->
   # returns the socket family as an integer.
   #
   #     p Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "").family
@@ -2519,6 +3024,10 @@ class Socket::AncillaryData
   #
   def family: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.inspect => string
+  # -->
   # returns a string which shows ancillarydata in human-readable form.
   #
   #     p Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "").inspect
@@ -2526,6 +3035,10 @@ class Socket::AncillaryData
   #
   def inspect: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.int => integer
+  # -->
   # Returns the data in *ancillarydata* as an int.
   #
   # The size and endian is dependent on the host.
@@ -2535,6 +3048,10 @@ class Socket::AncillaryData
   #
   def int: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancdata.ip_pktinfo => [addr, ifindex, spec_dst]
+  # -->
   # Extracts addr, ifindex and spec_dst from IP_PKTINFO ancillary data.
   #
   # IP_PKTINFO is not standard.
@@ -2548,8 +3065,12 @@ class Socket::AncillaryData
   #     p ancdata.ip_pktinfo
   #     #=> [#<Addrinfo: 127.0.0.1>, 0, #<Addrinfo: 127.0.0.1>]
   #
-  def ip_pktinfo: () -> [Addrinfo, Integer, Addrinfo]
+  def ip_pktinfo: () -> [ Addrinfo, Integer, Addrinfo ]
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancdata.ipv6_pktinfo => [addr, ifindex]
+  # -->
   # Extracts addr and ifindex from IPV6_PKTINFO ancillary data.
   #
   # IPV6_PKTINFO is defined by RFC 3542.
@@ -2559,8 +3080,12 @@ class Socket::AncillaryData
   #     ancdata = Socket::AncillaryData.ipv6_pktinfo(addr, ifindex)
   #     p ancdata.ipv6_pktinfo #=> [#<Addrinfo: ::1>, 0]
   #
-  def ipv6_pktinfo: () -> [Addrinfo, Integer]
+  def ipv6_pktinfo: () -> [ Addrinfo, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancdata.ipv6_pktinfo_addr => addr
+  # -->
   # Extracts addr from IPV6_PKTINFO ancillary data.
   #
   # IPV6_PKTINFO is defined by RFC 3542.
@@ -2572,6 +3097,10 @@ class Socket::AncillaryData
   #
   def ipv6_pktinfo_addr: () -> Addrinfo
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancdata.ipv6_pktinfo_ifindex => addr
+  # -->
   # Extracts ifindex from IPV6_PKTINFO ancillary data.
   #
   # IPV6_PKTINFO is defined by RFC 3542.
@@ -2583,6 +3112,10 @@ class Socket::AncillaryData
   #
   def ipv6_pktinfo_ifindex: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.level => integer
+  # -->
   # returns the cmsg level as an integer.
   #
   #     p Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "").level
@@ -2590,6 +3123,10 @@ class Socket::AncillaryData
   #
   def level: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.timestamp => time
+  # -->
   # returns the timestamp as a time object.
   #
   # *ancillarydata* should be one of following type:
@@ -2612,9 +3149,12 @@ class Socket::AncillaryData
   #
   #     }
   #
-  #
   def timestamp: () -> Time
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.type => integer
+  # -->
   # returns the cmsg type as an integer.
   #
   #     p Socket::AncillaryData.new(:INET6, :IPV6, :PKTINFO, "").type
@@ -2622,6 +3162,10 @@ class Socket::AncillaryData
   #
   def type: () -> Integer
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - ancillarydata.unix_rights => array-of-IOs or nil
+  # -->
   # returns the array of IO objects for SCM_RIGHTS control message in UNIX domain
   # socket.
   #
@@ -2652,6 +3196,10 @@ class Socket::AncillaryData
 
   private
 
+  # <!--
+  #   rdoc-file=ext/socket/ancdata.c
+  #   - Socket::AncillaryData.new(family, cmsg_level, cmsg_type, cmsg_data) -> ancillarydata
+  # -->
   # *family* should be an integer, a string or a symbol.
   # *   Socket::AF_INET, "AF_INET", "INET", :AF_INET, :INET
   # *   Socket::AF_UNIX, "AF_UNIX", "UNIX", :AF_UNIX, :UNIX