Ruby 4.1 リファレンスマニュアル

class Ractor::Port

[edit]

要約

Ractor 間でメッセージを交換するための仕組みを提供するクラスです。

目次

特異メソッド
インスタンスメソッド

特異メソッド

new -> Ractor::PortRuby 4.0 から[permalink][rdoc][edit]
() → void

インスタンスメソッド

self << msg, move: falseRuby 4.0 から[permalink][rdoc][edit]
send(msg, move: false)
(T obj, ?move: boolish) → self

Port にメッセージを送信します。

[PARAM] msg:
送信するメッセージを指定します。
[PARAM] move:
msg を「移動」する場合、true を指定します。
closeRuby 4.0 から[permalink][rdoc][edit]
() → void

Port を閉じます。

閉じられた Port に対して Ractor::Port#send による送信を試みた場合、 Ractor::ClosedError が発生します。 Port が閉じられる前に送信され、未受信のメッセージがある場合、その数ぶんだけ Ractor::Port#receive を使って受信できます。

Port を作成した Ractor 以外で close を呼ぶことはできません。

closed? -> boolRuby 4.0 から[permalink][rdoc][edit]
() → bool

Port が閉じられている場合、true を返します。

receive(timeout: nil) -> object | nilRuby 4.0 から[permalink][rdoc][edit]
() → T

Port に送信されたメッセージを受信します。

メッセージキューが空の場合はブロックします。

[PARAM] timeout:
メッセージを待つ秒数を数値で指定します。nil の場合は、メッセージが届くまで待ち続けます。指定した秒数が経過しても届かなかった場合は nil を返します。0 を指定した場合はブロックしません。
[EXCEPTION] ArgumentError:
timeout が負の場合に発生します。
[EXCEPTION] Ractor::ClosedError:
Port が閉じられている場合に発生します。
例: timeout を指定
port = Ractor::Port.new
p port.receive(timeout: 0.1) # => nil