【PHP8.x】resumeメソッドの使い方

Copy
1<?php
2
3/**
4 * Fiber::resume() のサンプルコード。
5 *
6 * Fiber を再開し、値を渡す。
7 */
8
9function create_fiber(mixed $initialValue): Fiber
10{
11    return new Fiber(function (mixed $value) use ($initialValue): mixed {
12        echo "Fiber: 開始\n";
13        $received_value = Fiber::suspend($initialValue); // Fiber を中断し、初期値を返す
14        echo "Fiber: 中断から再開、受信した値: " . $received_value . "\n";
15        return $value; // 最後に渡された値を返す
16    });
17}
18
19// Fiber の初期値を設定
20$initial_value = "初期値";
21
22// Fiber を作成
23$fiber = create_fiber($initial_value);
24
25// Fiber が中断しているか確認
26echo "Fiber の状態: " . ($fiber->isSuspended() ? '中断' : '実行中') . "\n";
27
28// Fiber を開始し、初期値を受け取る
29$result1 = $fiber->resume();
30echo "main: Fiber から受信した値: " . $result1 . "\n";
31
32// Fiber が中断しているか確認
33echo "Fiber の状態: " . ($fiber->isSuspended() ? '中断' : '実行中') . "\n";
34
35
36// Fiber を再開し、値を渡す
37$result2 = $fiber->resume("再開時の値");
38echo "main: Fiber から受信した値: " . $result2 . "\n";
39
40// Fiber が完了しているか確認
41echo "Fiber の状態: " . ($fiber->isTerminated() ? '完了' : '実行中') . "\n";
42
43// Fiber の戻り値を取得
44echo "Fiber の戻り値: " . $fiber->getReturn() . "\n";

Fiber::resume() は、PHP 8 で導入された Fiber クラスのメソッドで、中断された Fiber を再開するために使用します。

このサンプルコードでは、create_fiber() 関数内で Fiber を作成しています。Fiber は、Fiber::suspend() によって中断され、その際に $initialValue が返されます。

$fiber->resume() を最初に呼び出すと、Fiber が開始され、Fiber::suspend() で指定された初期値（この例では "初期値"）が返されます。この時点では、Fiber は Fiber::suspend() の実行後で中断状態になっています。

次に $fiber->resume("再開時の値") を呼び出すと、Fiber が中断状態から再開されます。resume() に渡された "再開時の値" は、Fiber::suspend() の戻り値として Fiber 内部で受け取られます。Fiber 内では、受け取った値が出力され、最後に resume() を呼び出す前に設定された $value (この例では"初期値")がFiberの戻り値として返されます。

Fiber::resume() の引数 $value は、中断された Fiber に渡す値です。戻り値は、Fiber 内で Fiber::suspend() が返す値、または Fiber の処理が完了した場合の Fiber 関数の戻り値です。このサンプルコードでは、Fiber が完了した後に $fiber->getReturn() で Fiber の戻り値を取得しています。

Copy
1<?php
2
3/**
4 * Fiber::resume() のサンプルコード
5 */
6
7// Fiberを定義
8$fiber = new Fiber(function (string $name): string {
9    // Fiberを中断し、値を返す
10    $greeting = Fiber::suspend("Hello, ");
11    return $greeting . $name . "!";
12});
13
14// Fiberを開始し、最初のsuspendまで実行
15$result = $fiber->start("World"); // "World" は Fiber の引数
16
17// suspend で返された値を確認
18echo "Fiber からの最初の戻り値: " . $result . PHP_EOL; // Fiber からの最初の戻り値: Hello,
19
20// Fiberを再開し、値を渡す
21$finalResult = $fiber->resume("Goodbye, "); // "Goodbye, " は suspend からの戻り値
22
23// Fiberの実行結果を表示
24echo "Fiber の最終的な戻り値: " . $finalResult . PHP_EOL; // Fiber の最終的な戻り値: Goodbye, World!

Fiber::resume()メソッドは、中断されたFiberを再開させるためのものです。このメソッドは、Fiberクラスに所属しており、PHP 8以降で使用できます。引数$valueは、中断されたFiberに渡す値で、型はmixed型です。省略した場合はnullが渡されます。この値は、Fiber内でFiber::suspend()によって中断された箇所で、その戻り値として利用できます。Fiber::resume()メソッドの戻り値もmixed型であり、Fiberが完了した場合は、Fiber内のクロージャの最終的な戻り値が返されます。

サンプルコードでは、まずFiberオブジェクトを生成しています。Fiberのクロージャ内では、Fiber::suspend()を使用してFiberを中断し、文字列"Hello, "を返しています。次に、$fiber->start("World")でFiberを開始し、最初のFiber::suspend()まで実行します。$fiber->start()に渡した"World"は、Fiberのクロージャの引数$nameに渡されます。この時点でFiberは中断され、$resultには"Hello, "が格納されます。

その後、$fiber->resume("Goodbye, ")を呼び出すことでFiberが再開されます。Fiber::resume()に渡した"Goodbye, "は、Fiber::suspend()の戻り値としてFiber内の$greeting変数に格納されます。Fiberは中断された箇所から処理を再開し、"Goodbye, "と"World"を連結して、最終的な戻り値"Goodbye, World!"を返します。この戻り値は$finalResultに格納され、最後に表示されます。Fiber::resume()を使うことで、Fiberの状態を制御し、値をやり取りしながら処理を進めることが可能になります。