rbs 1.2.1 → 1.3.0

data/stdlib/socket/0/unix_socket.rbs

@@ -0,0 +1,132 @@
+# UNIXSocket represents a UNIX domain stream client socket.
+class UNIXSocket < BasicSocket
+  # Creates a pair of sockets connected to each other.
+  #
+  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  #
+  # *protocol* should be a protocol defined in the domain. 0 is default protocol
+  # for the domain.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #     s1.send "a", 0
+  #     s1.send "b", 0
+  #     p s2.recv(10) #=> "ab"
+  #
+  def self.pair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+
+  # Creates a pair of sockets connected to each other.
+  #
+  # *socktype* should be a socket type such as: :STREAM, :DGRAM, :RAW, etc.
+  #
+  # *protocol* should be a protocol defined in the domain. 0 is default protocol
+  # for the domain.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #     s1.send "a", 0
+  #     s1.send "b", 0
+  #     p s2.recv(10) #=> "ab"
+  #
+  def self.socketpair: (?Symbol socktype, ?Integer protocol) -> [instance, instance]
+
+  public
+
+  # Returns the local address as an array which contains address_family and
+  # unix_path.
+  #
+  # Example
+  #     serv = UNIXServer.new("/tmp/sock")
+  #     p serv.addr #=> ["AF_UNIX", "/tmp/sock"]
+  #
+  def addr: () -> [String, String]
+
+  # Returns the path of the local address of unixsocket.
+  #
+  #     s = UNIXServer.new("/tmp/sock")
+  #     p s.path #=> "/tmp/sock"
+  #
+  def path: () -> String
+
+  # Returns the remote address as an array which contains address_family and
+  # unix_path.
+  #
+  # Example
+  #     serv = UNIXServer.new("/tmp/sock")
+  #     c = UNIXSocket.new("/tmp/sock")
+  #     p c.peeraddr #=> ["AF_UNIX", "/tmp/sock"]
+  #
+  def peeraddr: () -> [String, String]
+
+  # Example
+  #
+  #     UNIXServer.open("/tmp/sock") {|serv|
+  #       UNIXSocket.open("/tmp/sock") {|c|
+  #         s = serv.accept
+  #
+  #         c.send_io STDOUT
+  #         stdout = s.recv_io
+  #
+  #         p STDOUT.fileno #=> 1
+  #         p stdout.fileno #=> 7
+  #
+  #         stdout.puts "hello" # outputs "hello\n" to standard output.
+  #       }
+  #     }
+  #
+  # *klass* will determine the class of *io* returned (using the IO.for_fd
+  # singleton method or similar). If *klass* is `nil`, an integer file descriptor
+  # is returned.
+  #
+  # *mode* is the same as the argument passed to IO.for_fd
+  #
+  def recv_io: (?singleton(BasicSocket), ?String mode) -> BasicSocket
+
+  # Receives a message via *unixsocket*.
+  #
+  # *maxlen* is the maximum number of bytes to receive.
+  #
+  # *flags* should be a bitwise OR of Socket::MSG_* constants.
+  #
+  # *outbuf* will contain only the received data after the method call even if it
+  # is not empty at the beginning.
+  #
+  #     s1 = Socket.new(:UNIX, :DGRAM, 0)
+  #     s1_ai = Addrinfo.unix("/tmp/sock1")
+  #     s1.bind(s1_ai)
+  #
+  #     s2 = Socket.new(:UNIX, :DGRAM, 0)
+  #     s2_ai = Addrinfo.unix("/tmp/sock2")
+  #     s2.bind(s2_ai)
+  #     s3 = UNIXSocket.for_fd(s2.fileno)
+  #
+  #     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]]
+
+  # Sends *io* as file descriptor passing.
+  #
+  #     s1, s2 = UNIXSocket.pair
+  #
+  #     s1.send_io STDOUT
+  #     stdout = s2.recv_io
+  #
+  #     p STDOUT.fileno #=> 1
+  #     p stdout.fileno #=> 6
+  #
+  #     stdout.puts "hello" # outputs "hello\n" to standard output.
+  #
+  # *io* may be any kind of IO object or integer file descriptor.
+  #
+  def send_io: (BasicSocket | Integer) -> void
+
+  private
+
+  # Creates a new UNIX client socket connected to *path*.
+  #
+  #     require 'socket'
+  #
+  #     s = UNIXSocket.new("/tmp/sock")
+  #     s.send "hello", 0
+  #
+  def initialize: (String path) -> untyped
+end

data/stdlib/timeout/0/timeout.rbs

@@ -54,4 +54,9 @@ module Timeout
   def self?.timeout: [T] (Numeric? sec, ?singleton(Exception) klass, ?String message) { (Numeric sec) -> T } -> T
 end
 
+# Raised by Timeout.timeout when the block times out.
+class Timeout::Error < RuntimeError
+  attr_reader thread: Thread?
+end
+
 Timeout::VERSION: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -86,6 +86,7 @@ files:
 - core/unbound_method.rbs
 - core/warning.rbs
 - docs/CONTRIBUTING.md
+- docs/rbs_by_example.md
 - docs/repo.md
 - docs/sigs.md
 - docs/stdlib.md
@@ -213,12 +214,15 @@ files:
 - stdlib/logger/0/severity.rbs
 - stdlib/monitor/0/monitor.rbs
 - stdlib/mutex_m/0/mutex_m.rbs
+- stdlib/net-http/0/net-http.rbs
+- stdlib/optparse/0/optparse.rbs
 - stdlib/pathname/0/pathname.rbs
 - stdlib/prettyprint/0/prettyprint.rbs
 - stdlib/prime/0/integer-extension.rbs
 - stdlib/prime/0/prime.rbs
 - stdlib/pstore/0/pstore.rbs
 - stdlib/pty/0/pty.rbs
+- stdlib/resolv/0/resolv.rbs
 - stdlib/rubygems/0/basic_specification.rbs
 - stdlib/rubygems/0/config_file.rbs
 - stdlib/rubygems/0/dependency_installer.rbs
@@ -237,6 +241,15 @@ files:
 - stdlib/set/0/set.rbs
 - stdlib/shellwords/0/shellwords.rbs
 - stdlib/singleton/0/singleton.rbs
+- stdlib/socket/0/addrinfo.rbs
+- stdlib/socket/0/basic_socket.rbs
+- stdlib/socket/0/ip_socket.rbs
+- stdlib/socket/0/socket.rbs
+- stdlib/socket/0/tcp_server.rbs
+- stdlib/socket/0/tcp_socket.rbs
+- stdlib/socket/0/udp_socket.rbs
+- stdlib/socket/0/unix_server.rbs
+- stdlib/socket/0/unix_socket.rbs
 - stdlib/strscan/0/string_scanner.rbs
 - stdlib/time/0/time.rbs
 - stdlib/timeout/0/timeout.rbs
@@ -281,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Type signature for Ruby.