rbs 3.10.0 → 4.0.0.dev.1

data/core/ractor.rbs

@@ -1,9 +1,12 @@
 # <!-- rdoc-file=ractor.rb -->
+# Ractor is an Actor-model abstraction for Ruby that provides thread-safe
+# parallel execution.
+#
 # Ractor.new makes a new Ractor, which can run in parallel.
 #
 #     # The simplest ractor
 #     r = Ractor.new {puts "I am in Ractor!"}
-#     r.join # wait for it to finish
+#     r.take # wait for it to finish
 #     # Here, "I am in Ractor!" is printed
 #
 # Ractors do not share all objects with each other. There are two main benefits
@@ -37,12 +40,55 @@
 #       puts "I am in Ractor! a=#{a_in_ractor}"
 #     end
 #     r.send(a)  # pass it
-#     r.join
+#     r.take
 #     # Here, "I am in Ractor! a=1" is printed
 #
+# There are two pairs of methods for sending/receiving messages:
+#
+# *   Ractor#send and Ractor.receive for when the *sender* knows the receiver
+#     (push);
+# *   Ractor.yield and Ractor#take for when the *receiver* knows the sender
+#     (pull);
+#
 # In addition to that, any arguments passed to Ractor.new are passed to the
 # block and available there as if received by Ractor.receive, and the last block
-# value can be received with Ractor#value.
+# value is sent outside of the ractor as if sent by Ractor.yield.
+#
+# A little demonstration of a classic ping-pong:
+#
+#     server = Ractor.new(name: "server") do
+#       puts "Server starts: #{self.inspect}"
+#       puts "Server sends: ping"
+#       Ractor.yield 'ping'                       # The server doesn't know the receiver and sends to whoever interested
+#       received = Ractor.receive                 # The server doesn't know the sender and receives from whoever sent
+#       puts "Server received: #{received}"
+#     end
+#
+#     client = Ractor.new(server) do |srv|        # The server is sent to the client, and available as srv
+#       puts "Client starts: #{self.inspect}"
+#       received = srv.take                       # The client takes a message from the server
+#       puts "Client received from " \
+#            "#{srv.inspect}: #{received}"
+#       puts "Client sends to " \
+#            "#{srv.inspect}: pong"
+#       srv.send 'pong'                           # The client sends a message to the server
+#     end
+#
+#     [client, server].each(&:take)               # Wait until they both finish
+#
+# This will output something like:
+#
+#     Server starts: #<Ractor:#2 server test.rb:1 running>
+#     Server sends: ping
+#     Client starts: #<Ractor:#3 test.rb:8 running>
+#     Client received from #<Ractor:#2 server test.rb:1 blocking>: ping
+#     Client sends to #<Ractor:#2 server test.rb:1 blocking>: pong
+#     Server received: pong
+#
+# Ractors receive their messages via the *incoming port*, and send them to the
+# *outgoing port*. Either one can be disabled with Ractor#close_incoming and
+# Ractor#close_outgoing, respectively. When a ractor terminates, its ports are
+# closed automatically.
 #
 # ## Shareable and unshareable objects
 #
@@ -82,7 +128,7 @@
 #       puts "In ractor: #{data2.object_id}, #{data2[0].object_id}, #{data2[1].object_id}"
 #     end
 #     r.send(data)
-#     r.join
+#     r.take
 #     puts "Outside  : #{data.object_id}, #{data[0].object_id}, #{data[1].object_id}"
 #
 # This will output something like:
@@ -105,7 +151,7 @@
 #       puts "In ractor: #{data_in_ractor.object_id}, #{data_in_ractor[0].object_id}"
 #     end
 #     r.send(data, move: true)
-#     r.join
+#     r.take
 #     puts "Outside: moved? #{Ractor::MovedObject === data}"
 #     puts "Outside: #{data.inspect}"
 #
@@ -118,7 +164,7 @@
 # Notice that even `inspect` (and more basic methods like `__id__`) is
 # inaccessible on a moved object.
 #
-# `Class` and `Module` objects are shareable so the class/module definitions are
+# Class and Module objects are shareable so the class/module definitions are
 # shared between ractors. Ractor objects are also shareable. All operations on
 # shareable objects are thread-safe, so the thread-safety property will be kept.
 # We can not define mutable shareable objects in Ruby, but C extensions can
@@ -143,7 +189,7 @@
 #       puts "I can't see #{cls.tricky}"
 #       cls.tricky = true # doesn't get here, but this would also raise an error
 #     end
-#     r.join
+#     r.take
 #     # I see C
 #     # can not access instance variables of classes/modules from non-main Ractors (RuntimeError)
 #
@@ -157,7 +203,7 @@
 #       puts "GOOD=#{GOOD}"
 #       puts "BAD=#{BAD}"
 #     end
-#     r.join
+#     r.take
 #     # GOOD=good
 #     # can not access non-shareable objects in constant Object::BAD by non-main Ractor. (NameError)
 #
@@ -167,7 +213,7 @@
 #       puts "I see #{C}"
 #       puts "I can't see #{C.tricky}"
 #     end
-#     r.join
+#     r.take
 #     # I see C
 #     # can not access instance variables of classes/modules from non-main Ractors (RuntimeError)
 #
@@ -183,7 +229,7 @@
 #       a = 1
 #       Thread.new {puts "Thread in ractor: a=#{a}"}.join
 #     end
-#     r.join
+#     r.take
 #     # Here "Thread in ractor: a=1" will be printed
 #
 # ## Note on code examples
@@ -196,7 +242,7 @@
 #     end
 #
 # It is **only for demonstration purposes** and shouldn't be used in a real
-# code. Most of the time, #join is used to wait for ractors to finish.
+# code. Most of the time, #take is used to wait for ractors to finish.
 #
 # ## Reference
 #
@@ -234,10 +280,10 @@ class Ractor
   # Returns the number of Ractors currently running or blocking (waiting).
   #
   #     Ractor.count                   #=> 1
-  #     r = Ractor.new(name: 'example') { Ractor.receive }
+  #     r = Ractor.new(name: 'example') { Ractor.yield(1) }
   #     Ractor.count                   #=> 2 (main + example ractor)
-  #     r << 42                        # r's Ractor.receive will resume
-  #     r.join                         # wait for r's termination
+  #     r.take                         # wait for Ractor.yield(1)
+  #     r.take                         # wait until r will finish
   #     Ractor.count                   #=> 1
   #
   def self.count: () -> Integer
@@ -317,7 +363,7 @@ class Ractor
   # `self` inside the block will refer to the current Ractor.
   #
   #     r = Ractor.new { puts "Hi, I am #{self.inspect}" }
-  #     r.join
+  #     r.take
   #     # Prints "Hi, I am #<Ractor:#2 test.rb:1 running>"
   #
   # Any `args` passed are propagated to the block arguments by the same rules as
@@ -329,14 +375,14 @@ class Ractor
   #     r = Ractor.new(arg) {|received_arg|
   #       puts "Received: #{received_arg} (##{received_arg.object_id})"
   #     }
-  #     r.join
+  #     r.take
   #     # Prints:
   #     #   Passing: [1, 2, 3] (#280)
   #     #   Received: [1, 2, 3] (#300)
   #
   # Ractor's `name` can be set for debugging purposes:
   #
-  #     r = Ractor.new(name: 'my ractor') {}; r.join
+  #     r = Ractor.new(name: 'my ractor') {}; r.take
   #     p r
   #     #=> #<Ractor:#3 my ractor test.rb:1 terminated>
   #
@@ -344,77 +390,209 @@ class Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.receive -> obj
+  #   - Ractor.receive -> msg
   # -->
-  # Receive a message from the default port.
+  # Receive a message from the incoming port of the current ractor (which was sent
+  # there by #send from another ractor).
+  #
+  #     r = Ractor.new do
+  #       v1 = Ractor.receive
+  #       puts "Received: #{v1}"
+  #     end
+  #     r.send('message1')
+  #     r.take
+  #     # Here will be printed: "Received: message1"
+  #
+  # Alternatively, the private instance method `receive` may be used:
+  #
+  #     r = Ractor.new do
+  #       v1 = receive
+  #       puts "Received: #{v1}"
+  #     end
+  #     r.send('message1')
+  #     r.take
+  #     # This prints: "Received: message1"
+  #
+  # The method blocks if the queue is empty.
+  #
+  #     r = Ractor.new do
+  #       puts "Before first receive"
+  #       v1 = Ractor.receive
+  #       puts "Received: #{v1}"
+  #       v2 = Ractor.receive
+  #       puts "Received: #{v2}"
+  #     end
+  #     wait
+  #     puts "Still not received"
+  #     r.send('message1')
+  #     wait
+  #     puts "Still received only one"
+  #     r.send('message2')
+  #     r.take
+  #
+  # Output:
+  #
+  #     Before first receive
+  #     Still not received
+  #     Received: message1
+  #     Still received only one
+  #     Received: message2
+  #
+  # If close_incoming was called on the ractor, the method raises
+  # Ractor::ClosedError if there are no more messages in the incoming queue:
+  #
+  #     Ractor.new do
+  #       close_incoming
+  #       receive
+  #     end
+  #     wait
+  #     # in `receive': The incoming port is already closed => #<Ractor:#2 test.rb:1 running> (Ractor::ClosedError)
   #
   def self.receive: () -> untyped
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - recv()
+  #   - Ractor.receive_if {|msg| block } -> msg
   # -->
+  # Receive only a specific message.
   #
-  alias self.recv self.receive
+  # Instead of Ractor.receive, Ractor.receive_if can be given a pattern (or any
+  # filter) in a block and you can choose the messages to accept that are
+  # available in your ractor's incoming queue.
+  #
+  #     r = Ractor.new do
+  #       p Ractor.receive_if{|msg| msg.match?(/foo/)} #=> "foo3"
+  #       p Ractor.receive_if{|msg| msg.match?(/bar/)} #=> "bar1"
+  #       p Ractor.receive_if{|msg| msg.match?(/baz/)} #=> "baz2"
+  #     end
+  #     r << "bar1"
+  #     r << "baz2"
+  #     r << "foo3"
+  #     r.take
+  #
+  # This will output:
+  #
+  #     foo3
+  #     bar1
+  #     baz2
+  #
+  # If the block returns a truthy value, the message is removed from the incoming
+  # queue and returned. Otherwise, the message remains in the incoming queue and
+  # the next messages are checked by the given block.
+  #
+  # If there are no messages left in the incoming queue, the method will block
+  # until new messages arrive.
+  #
+  # If the block is escaped by break/return/exception/throw, the message is
+  # removed from the incoming queue as if a truthy value had been returned.
+  #
+  #     r = Ractor.new do
+  #       val = Ractor.receive_if{|msg| msg.is_a?(Array)}
+  #       puts "Received successfully: #{val}"
+  #     end
+  #
+  #     r.send(1)
+  #     r.send('test')
+  #     wait
+  #     puts "2 non-matching sent, nothing received"
+  #     r.send([1, 2, 3])
+  #     wait
+  #
+  # Prints:
+  #
+  #     2 non-matching sent, nothing received
+  #     Received successfully: [1, 2, 3]
+  #
+  # Note that you can not call receive/receive_if in the given block recursively.
+  # You should not do any tasks in the block other than message filtration.
+  #
+  #     Ractor.current << true
+  #     Ractor.receive_if{|msg| Ractor.receive}
+  #     #=> `receive': can not call receive/receive_if recursively (Ractor::Error)
+  #
+  def self.receive_if: () { (untyped) -> boolish } -> untyped
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.select(*ports) -> [...]
+  #   - recv()
   # -->
-  # TBD
   #
-  def self.select: (?) -> Array[untyped]
+  alias self.recv self.receive
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.shareable?(obj) -> true | false
+  #   - Ractor.select(*ractors, [yield_value:, move: false]) -> [ractor or symbol, obj]
   # -->
-  # Checks if the object is shareable by ractors.
+  # Wait for any ractor to have something in its outgoing port, read from this
+  # ractor, and then return that ractor and the object received.
   #
-  #     Ractor.shareable?(1)            #=> true -- numbers and other immutable basic values are frozen
-  #     Ractor.shareable?('foo')        #=> false, unless the string is frozen due to # frozen_string_literal: true
-  #     Ractor.shareable?('foo'.freeze) #=> true
+  #     r1 = Ractor.new {Ractor.yield 'from 1'}
+  #     r2 = Ractor.new {Ractor.yield 'from 2'}
   #
-  # See also the "Shareable and unshareable objects" section in the Ractor class
-  # docs.
+  #     r, obj = Ractor.select(r1, r2)
   #
-  def self.shareable?: (untyped obj) -> bool
-
-  # <!--
-  #   rdoc-file=ractor.rb
-  #   - Ractor.shareable_proc(self: nil){} -> shareable proc
-  # -->
-  # It returns shareable Proc object. The Proc object is shareable and the self in
-  # a block will be replaced with the value passed via `self:` keyword.
+  #     puts "received #{obj.inspect} from #{r.inspect}"
+  #     # Prints: received "from 1" from #<Ractor:#2 test.rb:1 running>
+  #     # But could just as well print "from r2" here, either prints could be first.
+  #
+  # If one of the given ractors is the current ractor, and it is selected, `r`
+  # will contain the `:receive` symbol instead of the ractor object.
+  #
+  #     r1 = Ractor.new(Ractor.current) do |main|
+  #       main.send 'to main'
+  #       Ractor.yield 'from 1'
+  #     end
+  #     r2 = Ractor.new do
+  #       Ractor.yield 'from 2'
+  #     end
+  #
+  #     r, obj = Ractor.select(r1, r2, Ractor.current)
+  #     puts "received #{obj.inspect} from #{r.inspect}"
+  #     # Could print: received "to main" from :receive
+  #
+  # If `yield_value` is provided, that value may be yielded if another ractor is
+  # calling #take. In this case, the pair `[:yield, nil]` is returned:
   #
-  # In a shareable Proc, you can not access to the outer variables.
+  #     r1 = Ractor.new(Ractor.current) do |main|
+  #       puts "Received from main: #{main.take}"
+  #     end
+  #
+  #     puts "Trying to select"
+  #     r, obj = Ractor.select(r1, Ractor.current, yield_value: 123)
+  #     wait
+  #     puts "Received #{obj.inspect} from #{r.inspect}"
   #
-  #     a = 42
-  #     Ractor.shareable_proc{ p a }
-  #     #=> can not isolate a Proc because it accesses outer variables (a). (ArgumentError)
+  # This will print:
   #
-  # The `self` should be a shareable object
+  #     Trying to select
+  #     Received from main: 123
+  #     Received nil from :yield
   #
-  #     Ractor.shareable_proc(self: self){}
-  #     #=> self should be shareable: main (Ractor::IsolationError)
+  # `move` boolean flag defines whether yielded value will be copied (default) or
+  # moved.
   #
-  def self.shareable_proc: [T] () { (?) [self: nil] -> T } -> ^(?) [self: nil] -> T
-                         | [T, S] (self: S) { (?) [self: S] -> T } -> ^(?) [self: S] -> T
+  def self.select: (*Ractor ractors, ?move: boolish, ?yield_value: untyped) -> [ Ractor | Symbol, untyped ]
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - Ractor.shareable_proc{} -> shareable proc
+  #   - Ractor.shareable?(obj) -> true | false
   # -->
-  # Same as Ractor.shareable_proc, but returns lambda proc.
+  # Checks if the object is shareable by ractors.
   #
-  def self.shareable_lambda: [T] () { (?) [self: nil] -> T } -> ^(?) [self: nil] -> T
-                           | [T, S] (self: S) { (?) [self: S] -> T } -> ^(?) [self: S] -> T
+  #     Ractor.shareable?(1)            #=> true -- numbers and other immutable basic values are frozen
+  #     Ractor.shareable?('foo')        #=> false, unless the string is frozen due to # frozen_string_literal: true
+  #     Ractor.shareable?('foo'.freeze) #=> true
+  #
+  # See also the "Shareable and unshareable objects" section in the Ractor class
+  # docs.
+  #
+  def self.shareable?: (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=ractor.rb
   #   - Ractor.store_if_absent(key){ init_block }
   # -->
-  # If the corresponding value is not set, yield a value with init_block and store
+  # If the correponding value is not set, yield a value with init_block and store
   # the value in thread-safe manner. This method returns corresponding stored
   # value.
   #
@@ -429,7 +607,47 @@ class Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - <<(...)
+  #   - Ractor.yield(msg, move: false) -> nil
+  # -->
+  # Send a message to the current ractor's outgoing port to be accepted by #take.
+  #
+  #     r = Ractor.new {Ractor.yield 'Hello from ractor'}
+  #     puts r.take
+  #     # Prints: "Hello from ractor"
+  #
+  # This method is blocking, and will return only when somebody consumes the sent
+  # message.
+  #
+  #     r = Ractor.new do
+  #       Ractor.yield 'Hello from ractor'
+  #       puts "Ractor: after yield"
+  #     end
+  #     wait
+  #     puts "Still not taken"
+  #     puts r.take
+  #
+  # This will print:
+  #
+  #     Still not taken
+  #     Hello from ractor
+  #     Ractor: after yield
+  #
+  # If the outgoing port was closed with #close_outgoing, the method will raise:
+  #
+  #     r = Ractor.new do
+  #       close_outgoing
+  #       Ractor.yield 'Hello from ractor'
+  #     end
+  #     wait
+  #     # `yield': The outgoing-port is already closed (Ractor::ClosedError)
+  #
+  # The meaning of the `move` argument is the same as for #send.
+  #
+  def self.yield: (untyped obj, ?move: boolish) -> untyped
+
+  # <!--
+  #   rdoc-file=ractor.rb
+  #   - <<(obj, move: false)
   # -->
   #
   alias << send
@@ -438,50 +656,58 @@ class Ractor
   #   rdoc-file=ractor.rb
   #   - [](sym)
   # -->
-  # get a value from ractor-local storage for current Ractor Obsolete and use
+  # get a value from ractor-local storage of current Ractor Obsolete and use
   # Ractor.[] instead.
   #
-  %a{deprecated: Use Ractor.[] instead}
   def []: (interned sym) -> untyped
 
   # <!--
   #   rdoc-file=ractor.rb
   #   - []=(sym, val)
   # -->
-  # set a value in ractor-local storage for current Ractor Obsolete and use
+  # set a value in ractor-local storage of current Ractor Obsolete and use
   # Ractor.[]= instead.
   #
-  %a{deprecated: Use Ractor.[]= instead}
   def []=: [T] (interned sym, T val) -> T
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - ractor.default_port -> port object
+  #   - ractor.close_incoming -> true | false
   # -->
-  # return default port of the Ractor.
+  # Closes the incoming port and returns whether it was already closed. All
+  # further attempts to Ractor.receive in the ractor, and #send to the ractor will
+  # fail with Ractor::ClosedError.
+  #
+  #     r = Ractor.new {sleep(500)}
+  #     r.close_incoming  #=> false
+  #     r.close_incoming  #=> true
+  #     r.send('test')
+  #     # Ractor::ClosedError (The incoming-port is already closed)
   #
-  def default_port: () -> Port[untyped]
+  def close_incoming: () -> bool
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - inspect()
+  #   - ractor.close_outgoing -> true | false
   # -->
+  # Closes the outgoing port and returns whether it was already closed. All
+  # further attempts to Ractor.yield in the ractor, and #take from the ractor will
+  # fail with Ractor::ClosedError.
   #
-  def inspect: () -> String
+  #     r = Ractor.new {sleep(500)}
+  #     r.close_outgoing  #=> false
+  #     r.close_outgoing  #=> true
+  #     r.take
+  #     # Ractor::ClosedError (The outgoing-port is already closed)
+  #
+  def close_outgoing: () -> bool
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - ractor.join -> self
+  #   - inspect()
   # -->
-  # Wait for the termination of the Ractor. If the Ractor was aborted (terminated
-  # with an exception), Ractor#value is called to raise an exception.
   #
-  #     Ractor.new{}.join #=> ractor
-  #
-  #     Ractor.new{ raise "foo" }.join
-  #     #=> raise an exception "foo (RuntimeError)"
-  #
-  def join: () -> self
+  def inspect: () -> String
 
   # <!--
   #   rdoc-file=ractor.rb
@@ -493,60 +719,162 @@ class Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - ractor.monitor(port) -> self
+  #   - ractor.send(msg, move: false) -> self
   # -->
-  # Register port as a monitoring port. If the ractor terminated, the port
-  # received a Symbol object. :exited will be sent if the ractor terminated
-  # without an exception. :aborted will be sent if the ractor terminated with a
-  # exception.
+  # Send a message to a Ractor's incoming queue to be accepted by Ractor.receive.
   #
-  #     r = Ractor.new{ some_task() }
-  #     r.monitor(port = Ractor::Port.new)
-  #     port.receive #=> :exited and r is terminated
+  #     r = Ractor.new do
+  #       value = Ractor.receive
+  #       puts "Received #{value}"
+  #     end
+  #     r.send 'message'
+  #     # Prints: "Received: message"
   #
-  #     r = Ractor.new{ raise "foo" }
-  #     r.monitor(port = Ractor::Port.new)
-  #     port.receive #=> :terminated and r is terminated with an exception "foo"
+  # The method is non-blocking (will return immediately even if the ractor is not
+  # ready to receive anything):
   #
-  def monitor: [T < Symbol] (Port[T]) -> untyped
-
-  # <!--
-  #   rdoc-file=ractor.rb
-  #   - ractor.send(msg) -> self
-  # -->
-  # It is equivalent to default_port.send(msg)
+  #     r = Ractor.new {sleep(5)}
+  #     r.send('test')
+  #     puts "Sent successfully"
+  #     # Prints: "Sent successfully" immediately
+  #
+  # An attempt to send to a ractor which already finished its execution will raise
+  # Ractor::ClosedError.
+  #
+  #     r = Ractor.new {}
+  #     r.take
+  #     p r
+  #     # "#<Ractor:#6 (irb):23 terminated>"
+  #     r.send('test')
+  #     # Ractor::ClosedError (The incoming-port is already closed)
+  #
+  # If close_incoming was called on the ractor, the method also raises
+  # Ractor::ClosedError.
+  #
+  #     r =  Ractor.new do
+  #       sleep(500)
+  #       receive
+  #     end
+  #     r.close_incoming
+  #     r.send('test')
+  #     # Ractor::ClosedError (The incoming-port is already closed)
+  #     # The error is raised immediately, not when the ractor tries to receive
+  #
+  # If the `obj` is unshareable, by default it will be copied into the receiving
+  # ractor by deep cloning. If `move: true` is passed, the object is *moved* into
+  # the receiving ractor and becomes inaccessible to the sender.
+  #
+  #     r = Ractor.new {puts "Received: #{receive}"}
+  #     msg = 'message'
+  #     r.send(msg, move: true)
+  #     r.take
+  #     p msg
+  #
+  # This prints:
+  #
+  #     Received: message
+  #     in `p': undefined method `inspect' for #<Ractor::MovedObject:0x000055c99b9b69b8>
+  #
+  # All references to the object and its parts will become invalid to the sender.
+  #
+  #     r = Ractor.new {puts "Received: #{receive}"}
+  #     s = 'message'
+  #     ary = [s]
+  #     copy = ary.dup
+  #     r.send(ary, move: true)
+  #
+  #     s.inspect
+  #     # Ractor::MovedError (can not send any methods to a moved object)
+  #     ary.class
+  #     # Ractor::MovedError (can not send any methods to a moved object)
+  #     copy.class
+  #     # => Array, it is different object
+  #     copy[0].inspect
+  #     # Ractor::MovedError (can not send any methods to a moved object)
+  #     # ...but its item was still a reference to `s`, which was moved
+  #
+  # If the object is shareable, `move: true` has no effect on it:
+  #
+  #     r = Ractor.new {puts "Received: #{receive}"}
+  #     s = 'message'.freeze
+  #     r.send(s, move: true)
+  #     s.inspect #=> "message", still available
   #
   def send: (untyped obj, ?move: boolish) -> Ractor
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - to_s()
+  #   - ractor.take -> msg
   # -->
+  # Get a message from the ractor's outgoing port, which was put there by
+  # Ractor.yield or at ractor's termination.
   #
-  alias to_s inspect
-
-  # <!--
-  #   rdoc-file=ractor.rb
-  #   - ractor.unmonitor(port) -> self
-  # -->
-  # Unregister port from the monitoring ports.
+  #     r = Ractor.new do
+  #       Ractor.yield 'explicit yield'
+  #       'last value'
+  #     end
+  #     puts r.take #=> 'explicit yield'
+  #     puts r.take #=> 'last value'
+  #     puts r.take # Ractor::ClosedError (The outgoing-port is already closed)
+  #
+  # The fact that the last value is also sent to the outgoing port means that
+  # `take` can be used as an analog of Thread#join ("just wait until ractor
+  # finishes"). However, it will raise if somebody has already consumed that
+  # message.
+  #
+  # If the outgoing port was closed with #close_outgoing, the method will raise
+  # Ractor::ClosedError.
   #
-  def unmonitor: (Port[untyped]) -> self
+  #     r = Ractor.new do
+  #       sleep(500)
+  #       Ractor.yield 'Hello from ractor'
+  #     end
+  #     r.close_outgoing
+  #     r.take
+  #     # Ractor::ClosedError (The outgoing-port is already closed)
+  #     # The error would be raised immediately, not when ractor will try to receive
+  #
+  # If an uncaught exception is raised in the Ractor, it is propagated by take as
+  # a Ractor::RemoteError.
+  #
+  #     r = Ractor.new {raise "Something weird happened"}
+  #
+  #     begin
+  #       r.take
+  #     rescue => e
+  #       p e              #  => #<Ractor::RemoteError: thrown by remote Ractor.>
+  #       p e.ractor == r  # => true
+  #       p e.cause        # => #<RuntimeError: Something weird happened>
+  #     end
+  #
+  # Ractor::ClosedError is a descendant of StopIteration, so the termination of
+  # the ractor will break out of any loops that receive this message without
+  # propagating the error:
+  #
+  #     r = Ractor.new do
+  #       3.times {|i| Ractor.yield "message #{i}"}
+  #       "finishing"
+  #     end
+  #
+  #     loop {puts "Received: " + r.take}
+  #     puts "Continue successfully"
+  #
+  # This will print:
+  #
+  #     Received: message 0
+  #     Received: message 1
+  #     Received: message 2
+  #     Received: finishing
+  #     Continue successfully
+  #
+  def take: () -> untyped
 
   # <!--
   #   rdoc-file=ractor.rb
-  #   - ractor.value -> obj
+  #   - to_s()
   # -->
-  # Waits for `ractor` to complete, using #join, and return its value or raise the
-  # exception which terminated the Ractor. The value will not be copied even if it
-  # is unshareable object. Therefore at most 1 Ractor can get a value.
-  #
-  #     r = Ractor.new{ [1, 2] }
-  #     r.value #=> [1, 2] (unshareable object)
-  #
-  #     Ractor.new(r){|r| r.value} #=> Ractor::Error
   #
-  def value: () -> untyped
+  alias to_s inspect
 
   private
 
@@ -610,15 +938,9 @@ class Ractor
   class ClosedError < StopIteration
   end
 
-  # <!-- rdoc-file=ractor.c -->
-  # The parent class of Ractor-related error classes.
-  #
   class Error < RuntimeError
   end
 
-  # <!-- rdoc-file=ractor.c -->
-  # Raised on attempt to make a Ractor-unshareable object Ractor-shareable.
-  #
   class IsolationError < Ractor::Error
   end
 
@@ -715,166 +1037,6 @@ class Ractor
     def method_missing: (*untyped) -> untyped
   end
 
-  # <!-- rdoc-file=ractor.rb -->
-  # Port objects transmit messages between Ractors.
-  #
-  class Port[T = untyped]
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - <<(obj, move: false)
-    # -->
-    #
-    alias << send
-
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - port.close
-    # -->
-    # Close the port. On the closed port, sending is not prohibited. Receiving is
-    # also not allowed if there is no sent messages arrived before closing.
-    #
-    #     port = Ractor::Port.new
-    #     Ractor.new port do |port|
-    #       port.send 1 # OK
-    #       port.send 2 # OK
-    #       port.close
-    #       port.send 3 # raise Ractor::ClosedError
-    #     end
-    #
-    #     port.receive #=> 1
-    #     port.receive #=> 2
-    #     port.receive #=> raise Ractor::ClosedError
-    #
-    # Now, only a Ractor which creates the port is allowed to close ports.
-    #
-    #     port = Ractor::Port.new
-    #     Ractor.new port do |port|
-    #       port.close #=> closing port by other ractors is not allowed (Ractor::Error)
-    #     end.join
-    #
-    def close: () -> void
-
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - port.closed? -> true/false
-    # -->
-    # Return the port is closed or not.
-    #
-    def closed?: () -> bool
-
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - port.inspect -> string
-    # -->
-    #
-    def inspect: () -> String
-
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - port.receive -> msg
-    # -->
-    # Receive a message to the port (which was sent there by Port#send).
-    #
-    #     port = Ractor::Port.new
-    #     r = Ractor.new port do |port|
-    #       port.send('message1')
-    #     end
-    #
-    #     v1 = port.receive
-    #     puts "Received: #{v1}"
-    #     r.join
-    #     # Here will be printed: "Received: message1"
-    #
-    # The method blocks if the message queue is empty.
-    #
-    #     port = Ractor::Port.new
-    #     r = Ractor.new port do |port|
-    #       wait
-    #       puts "Still not received"
-    #       port.send('message1')
-    #       wait
-    #       puts "Still received only one"
-    #       port.send('message2')
-    #     end
-    #     puts "Before first receive"
-    #     v1 = port.receive
-    #     puts "Received: #{v1}"
-    #     v2 = port.receive
-    #     puts "Received: #{v2}"
-    #     r.join
-    #
-    # Output:
-    #
-    #     Before first receive
-    #     Still not received
-    #     Received: message1
-    #     Still received only one
-    #     Received: message2
-    #
-    # If close_incoming was called on the ractor, the method raises
-    # Ractor::ClosedError if there are no more messages in the message queue:
-    #
-    #     port = Ractor::Port.new
-    #     port.close
-    #     port.receive #=> raise Ractor::ClosedError
-    #
-    def receive: () -> T
-
-    # <!--
-    #   rdoc-file=ractor.rb
-    #   - port.send(msg, move: false) -> self
-    # -->
-    # Send a message to a port to be accepted by port.receive.
-    #
-    #     port = Ractor::Port.new
-    #     r = Ractor.new do
-    #       r.send 'message'
-    #     end
-    #     value = port.receive
-    #     puts "Received #{value}"
-    #     # Prints: "Received: message"
-    #
-    # The method is non-blocking (will return immediately even if the ractor is not
-    # ready to receive anything):
-    #
-    #     port = Ractor::Port.new
-    #     r = Ractor.new(port) do |port|
-    #       port.send 'test'}
-    #       puts "Sent successfully"
-    #       # Prints: "Sent successfully" immediately
-    #     end
-    #
-    # An attempt to send to a port which already closed its execution will raise
-    # Ractor::ClosedError.
-    #
-    #     r = Ractor.new {Ractor::Port.new}
-    #     r.join
-    #     p r
-    #     # "#<Ractor:#6 (irb):23 terminated>"
-    #     port = r.value
-    #     port.send('test') # raise Ractor::ClosedError
-    #
-    # If the `obj` is unshareable, by default it will be copied into the receiving
-    # ractor by deep cloning.
-    #
-    # If the object is shareable, it only send a reference to the object without
-    # cloning.
-    #
-    def send: (T obj, ?move: boolish) -> self
-
-    private
-
-    # <!--
-    #   rdoc-file=ractor_sync.c
-    #   - Ractor::Port.new  -> new_port
-    # -->
-    # Returns a new Ractor::Port object.
-    #
-    def initialize: () -> void
-
-    def initialize_copy: (untyped) -> untyped
-  end
-
   # <!-- rdoc-file=ractor.c -->
   # Raised on attempt to Ractor#take if there was an uncaught exception in the
   # Ractor. Its `cause` will contain the original exception, and `ractor` is the
@@ -897,9 +1059,6 @@ class Ractor
     def ractor: () -> Ractor
   end
 
-  # <!-- rdoc-file=ractor.c -->
-  # Raised when Ractor-unsafe C-methods is invoked by a non-main Ractor.
-  #
   class UnsafeError < Ractor::Error
   end