rbs 2.0.0 → 2.1.0

data/stdlib/socket/0/tcp_server.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=ext/socket/tcpserver.c -->
 # TCPServer represents a TCP/IP server socket.
 #
 # A simple TCP server may look like:
@@ -24,9 +25,14 @@
 #         client.close
 #       end
 #     end
+#
 class TCPServer < TCPSocket
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/tcpserver.c
+  #   - tcpserver.accept => tcpsocket
+  # -->
   # Accepts an incoming connection. It returns a new TCPSocket object.
   #
   #     TCPServer.open("127.0.0.1", 14641) {|serv|
@@ -37,6 +43,10 @@ class TCPServer < TCPSocket
   #
   def accept: () -> TCPSocket
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - tcpserver.accept_nonblock([options]) => tcpsocket
+  # -->
   # Accepts an incoming connection using accept(2) after O_NONBLOCK is set for the
   # underlying file descriptor. It returns an accepted TCPSocket for the incoming
   # connection.
@@ -70,9 +80,12 @@ class TCPServer < TCPSocket
   # *   TCPServer#accept
   # *   Socket#accept
   #
-  #
   def accept_nonblock: (?exception: boolish) -> (TCPSocket | :wait_readable)
 
+  # <!--
+  #   rdoc-file=ext/socket/tcpserver.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.
@@ -142,9 +155,12 @@ class TCPServer < TCPSocket
   # *   listen manual pages on unix-based systems
   # *   listen function in Microsoft's Winsock functions reference
   #
-  #
   def listen: (Integer backlog) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/tcpserver.c
+  #   - tcpserver.sysaccept => file_descriptor
+  # -->
   # Returns a file descriptor of a accepted connection.
   #
   #     TCPServer.open("127.0.0.1", 28561) {|serv|
@@ -160,6 +176,10 @@ class TCPServer < TCPSocket
 
   def __accept_nonblock: (untyped) -> untyped
 
+  # <!--
+  #   rdoc-file=ext/socket/tcpserver.c
+  #   - TCPServer.new([hostname,] port) => tcpserver
+  # -->
   # Creates a new server socket bound to *port*.
   #
   # If *hostname* is given, the socket is bound to it.

data/stdlib/socket/0/tcp_socket.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=ext/socket/tcpsocket.c -->
 # TCPSocket represents a TCP/IP client socket.
 #
 # A simple client may look like:
@@ -11,7 +12,12 @@
 #     end
 #
 #     s.close             # close socket when done
+#
 class TCPSocket < IPSocket
+  # <!--
+  #   rdoc-file=ext/socket/tcpsocket.c
+  #   - TCPSocket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]
+  # -->
   # Use Addrinfo.getaddrinfo instead. This method is deprecated for the following
   # reasons:
   #
@@ -27,9 +33,14 @@ class TCPSocket < IPSocket
   #     TCPSocket.gethostbyname("localhost")
   #     #=> ["localhost", ["hal"], 2, "127.0.0.1"]
   #
-  def self.gethostbyname: (String host) -> [String, Array[String], Integer, String]
+  def self.gethostbyname: (String host) -> [ String, Array[String], Integer, String ]
 
   private
 
+  # <!--
+  #   rdoc-file=lib/resolv-replace.rb
+  #   - new(host, serv, *rest)
+  # -->
+  #
   def initialize: (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port) -> untyped
 end

data/stdlib/socket/0/udp_socket.rbs

@@ -1,7 +1,13 @@
+# <!-- rdoc-file=ext/socket/udpsocket.c -->
 # UDPSocket represents a UDP/IP socket.
+#
 class UDPSocket < IPSocket
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/udpsocket.c
+  #   - udpsocket.bind(host, port) #=> 0
+  # -->
   # Binds *udpsocket* to *host*:*port*.
   #
   #     u1 = UDPSocket.new
@@ -11,6 +17,10 @@ class UDPSocket < IPSocket
   #
   def bind: (String host, Integer port) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/udpsocket.c
+  #   - udpsocket.connect(host, port) => 0
+  # -->
   # Connects *udpsocket* to *host*:*port*.
   #
   # This makes possible to send without destination address.
@@ -24,6 +34,10 @@ class UDPSocket < IPSocket
   #
   def connect: (String host, Integer port) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - udpsocket.recvfrom_nonblock(maxlen [, flags[, outbuf [, options]]]) => [mesg, sender_inet_addr]
+  # -->
   # Receives up to *maxlen* bytes from `udpsocket` 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
@@ -73,9 +87,14 @@ class UDPSocket < IPSocket
   # ### See
   # *   Socket#recvfrom
   #
-  #
-  def recvfrom_nonblock: (Integer len, ?Integer flag, ?String outbuf, ?exception: boolish) -> [String, [String, Integer, String, String]]
+  def recvfrom_nonblock: (Integer len, ?Integer flag, ?String outbuf, ?exception: boolish) -> [ String, [ String, Integer, String, String ] ]
 
+  # <!--
+  #   rdoc-file=ext/socket/udpsocket.c
+  #   - udpsocket.send(mesg, flags, host, port)  => numbytes_sent
+  #   - udpsocket.send(mesg, flags, sockaddr_to) => numbytes_sent
+  #   - udpsocket.send(mesg, flags)              => numbytes_sent
+  # -->
   # Sends *mesg* via *udpsocket*.
   #
   # *flags* should be a bitwise OR of Socket::MSG_* constants.
@@ -97,6 +116,10 @@ class UDPSocket < IPSocket
 
   def __recvfrom_nonblock: (untyped, untyped, untyped, untyped) -> untyped
 
+  # <!--
+  #   rdoc-file=ext/socket/udpsocket.c
+  #   - UDPSocket.new([address_family]) => socket
+  # -->
   # Creates a new UDPSocket object.
   #
   # *address_family* should be an integer, a string or a symbol: Socket::AF_INET,

data/stdlib/socket/0/unix_server.rbs

@@ -1,7 +1,13 @@
+# <!-- rdoc-file=ext/socket/unixserver.c -->
 # UNIXServer represents a UNIX domain stream server socket.
+#
 class UNIXServer < UNIXSocket
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/unixserver.c
+  #   - unixserver.accept => unixsocket
+  # -->
   # Accepts an incoming connection. It returns a new UNIXSocket object.
   #
   #     UNIXServer.open("/tmp/sock") {|serv|
@@ -15,6 +21,10 @@ class UNIXServer < UNIXSocket
   #
   def accept: () -> UNIXSocket
 
+  # <!--
+  #   rdoc-file=ext/socket/lib/socket.rb
+  #   - unixserver.accept_nonblock([options]) => unixsocket
+  # -->
   # Accepts an incoming connection using accept(2) after O_NONBLOCK is set for the
   # underlying file descriptor. It returns an accepted UNIXSocket for the incoming
   # connection.
@@ -48,9 +58,12 @@ class UNIXServer < UNIXSocket
   # *   UNIXServer#accept
   # *   Socket#accept
   #
-  #
   def accept_nonblock: (?exception: boolish) -> (UNIXSocket | :wait_readable)
 
+  # <!--
+  #   rdoc-file=ext/socket/unixserver.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.
@@ -120,9 +133,12 @@ class UNIXServer < UNIXSocket
   # *   listen manual pages on unix-based systems
   # *   listen function in Microsoft's Winsock functions reference
   #
-  #
   def listen: (Integer backlog) -> void
 
+  # <!--
+  #   rdoc-file=ext/socket/unixserver.c
+  #   - unixserver.sysaccept => file_descriptor
+  # -->
   # Accepts a new connection. It returns the new file descriptor which is an
   # integer.
   #
@@ -142,6 +158,10 @@ class UNIXServer < UNIXSocket
 
   def __accept_nonblock: (untyped) -> untyped
 
+  # <!--
+  #   rdoc-file=ext/socket/unixserver.c
+  #   - UNIXServer.new(path) => unixserver
+  # -->
   # Creates a new UNIX server socket bound to *path*.
   #
   #     require 'socket'

data/stdlib/socket/0/unix_socket.rbs

@@ -1,5 +1,12 @@
+# <!-- rdoc-file=ext/socket/unixsocket.c -->
 # UNIXSocket represents a UNIX domain stream client socket.
+#
 class UNIXSocket < BasicSocket
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - UNIXSocket.pair([type [, protocol]])       => [unixsocket1, unixsocket2]
+  #   - UNIXSocket.socketpair([type [, protocol]]) => [unixsocket1, unixsocket2]
+  # -->
   # Creates a pair of sockets connected to each other.
   #
   # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
@@ -12,8 +19,13 @@ class UNIXSocket < BasicSocket
   #     s1.send "b", 0
   #     p s2.recv(10) #=> "ab"
   #
-  def self.pair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+  def self.pair: (?Symbol socktype, ?Integer protocol) -> [ instance, instance ]
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - UNIXSocket.pair([type [, protocol]])       => [unixsocket1, unixsocket2]
+  #   - UNIXSocket.socketpair([type [, protocol]]) => [unixsocket1, unixsocket2]
+  # -->
   # Creates a pair of sockets connected to each other.
   #
   # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
@@ -26,10 +38,14 @@ class UNIXSocket < BasicSocket
   #     s1.send "b", 0
   #     p s2.recv(10) #=> "ab"
   #
-  def self.socketpair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+  def self.socketpair: (?Symbol socktype, ?Integer protocol) -> [ instance, instance ]
 
   public
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.addr => [address_family, unix_path]
+  # -->
   # Returns the local address as an array which contains address_family and
   # unix_path.
   #
@@ -37,8 +53,12 @@ class UNIXSocket < BasicSocket
   #     serv = UNIXServer.new("/tmp/sock")
   #     p serv.addr #=> ["AF_UNIX", "/tmp/sock"]
   #
-  def addr: () -> [String, String]
+  def addr: () -> [ String, String ]
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.path => path
+  # -->
   # Returns the path of the local address of unixsocket.
   #
   #     s = UNIXServer.new("/tmp/sock")
@@ -46,6 +66,10 @@ class UNIXSocket < BasicSocket
   #
   def path: () -> String
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.peeraddr => [address_family, unix_path]
+  # -->
   # Returns the remote address as an array which contains address_family and
   # unix_path.
   #
@@ -54,8 +78,12 @@ class UNIXSocket < BasicSocket
   #     c = UNIXSocket.new("/tmp/sock")
   #     p c.peeraddr #=> ["AF_UNIX", "/tmp/sock"]
   #
-  def peeraddr: () -> [String, String]
+  def peeraddr: () -> [ String, String ]
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.recv_io([klass [, mode]]) => io
+  # -->
   # Example
   #
   #     UNIXServer.open("/tmp/sock") {|serv|
@@ -80,6 +108,10 @@ class UNIXSocket < BasicSocket
   #
   def recv_io: (?singleton(BasicSocket), ?String mode) -> BasicSocket
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.recvfrom(maxlen [, flags[, outbuf]]) => [mesg, unixaddress]
+  # -->
   # Receives a message via *unixsocket*.
   #
   # *maxlen* is the maximum number of bytes to receive.
@@ -101,8 +133,12 @@ class UNIXSocket < BasicSocket
   #     s1.send "a", 0, s2_ai
   #     p s3.recvfrom(10) #=> ["a", ["AF_UNIX", "/tmp/sock1"]]
   #
-  def recvfrom: (Integer maxlen, ?Integer flags, ?String outbuf) -> [String, [String, String]]
+  def recvfrom: (Integer maxlen, ?Integer flags, ?String outbuf) -> [ String, [ String, String ] ]
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - unixsocket.send_io(io) => nil
+  # -->
   # Sends *io* as file descriptor passing.
   #
   #     s1, s2 = UNIXSocket.pair
@@ -121,6 +157,10 @@ class UNIXSocket < BasicSocket
 
   private
 
+  # <!--
+  #   rdoc-file=ext/socket/unixsocket.c
+  #   - UNIXSocket.new(path) => unixsocket
+  # -->
   # Creates a new UNIX client socket connected to *path*.
   #
   #     require 'socket'