要約
並列プログラミングの仕組みを提供するクラスです。
目次
- 特異メソッド
- インスタンスメソッド
特異メソッド
self[sym] -> object | nil[permalink][rdoc][edit]-
このメソッドを呼び出した Ractor の Ractor-local storage の sym に対応するデータを取り出します。 sym に対応するデータがなければ nil を返します。
- [PARAM] sym:
- Ractor-local storage のキーを指定します。
- [RETURN]
- Ractor-local storage に格納されている値を返します。
self[sym] = val[permalink][rdoc][edit]-
- [PARAM] sym:
- Ractor-local storage のキーを指定します。
- [PARAM] val:
- 格納するデータを指定します。
count -> Integer[permalink][rdoc][edit]-
実行中の Ractor の数を返します。
current -> Ractor[permalink][rdoc][edit]-
このメソッドを呼び出された Ractor を返します。
main -> Ractor[permalink][rdoc][edit]-
main Ractor（プログラムの実行が開始された Ractor）を返します。
main? -> bool[permalink][rdoc][edit]-
このメソッドを呼び出した Ractor が main Ractor であるとき、true を返します。
make_shareable(obj, copy: false) -> object[permalink][rdoc][edit]-
obj が shareable になるよう変換します。
obj が shareable でない場合、obj と obj が参照する shareable でないオブジェクトをすべて freeze します。
- [PARAM] obj:
- Shareable にしたいオブジェクトを指定します。
- [PARAM] copy:
- true の場合、obj を変更する代わりに obj のコピーを作成し shareable にします。
new(*args, name: nil) {|*args| ... } -> Ractor[permalink][rdoc][edit]-
Ractor を生成して、ブロックの評価を開始します。生成した Ractor を返します。
- [PARAM] args:
- ブロックの引数として渡されます。値が shareable である場合はそのインスタンスが、そうでない場合はコピーが試みられた値が渡されます。コピーできない値であった場合は例外が発生します。
- [PARAM] name:
- Ractor の名前を指定します。
receive -> object[permalink][rdoc][edit]recv -> object-
このメソッドを呼び出した Ractor が受信したメッセージを取り出して返します。メッセージが届くまでブロックします。
他の Ractor から Ractor#send で送られたメッセージを受信します。
receive_if {|msg| ... } -> object[permalink][rdoc][edit]-
このメソッドを呼び出した Ractor が受信したメッセージのうち、ブロックの評価結果が真になる最初のメッセージを受信して返します。
select(*ractors, yield_value: nil, move: false) -> [object, object][permalink][rdoc][edit]-
引数で指定した Ractor のいずれかが Ractor.yield などで送信可能になるまで待ち、その Ractor と受信したオブジェクトの配列 [Ractor, obj] を返します。受信したのが現在の Ractor 自身であった場合は、Ractor の代わりに :receive シンボルが返ります。 yield_value を指定すると、他の Ractor が Ractor#take を呼んだときにその値が yield され、 [:yield, nil] が返ります。move が真のとき yield_value は移動されます。
shareable?(obj) -> bool[permalink][rdoc][edit]-
obj が shareable である場合、true を返します。
- [PARAM] obj:
- Shareable であるか判定したいオブジェクトを指定します。
store_if_absent(key) { ... } -> object[permalink][rdoc][edit]-
このメソッドを呼び出した Ractor の Ractor-local storage の key データがない場合、ブロックを評価した結果を格納します。格納した値を返します。
- [PARAM] key:
- Ractor-local storage のキーを指定します。
yield(obj, move: false) -> object[permalink][rdoc][edit]-
現在の Ractor の outgoing port に obj を送信します。別の Ractor が Ractor#take でこのメッセージを受信するまでブロックします。
- [PARAM] obj:
- 送信するオブジェクトを指定します。
- [PARAM] move:
- obj を「移動」する場合は true を指定します。
インスタンスメソッド
self << msg, move: false -> self[permalink][rdoc][edit]send(msg, move: false) -> self-
self にメッセージを送信します。送られたメッセージは self が Ractor.receive で受信できます。
- [PARAM] msg:
- 送信するメッセージを指定します。
- [PARAM] move:
- msg を「移動」する場合は true を指定します。
name -> String[permalink][rdoc][edit]-
self の名前を返します。
[SEE_ALSO] Ractor.new
take -> object[permalink][rdoc][edit]-
self の outgoing port からメッセージを受信します。 self が Ractor.yield で送ったメッセージ、または self のブロックが返した値を受け取ります。メッセージが届くまでブロックします。