【PHP8.x】Fiber::isSuspended()メソッドの使い方

Copy
1<?php
2
3/**
4 * Fiber::isSuspended() の使用例
5 *
6 * このサンプルコードは、PHP 8で導入されたFiber（ファイバー）の
7 * isSuspended() メソッドの基本的な使い方を示します。
8 * isSuspended() は、ファイバーが現在中断されている状態にあるかを判定します。
9 */
10
11// ファイバーで実行される処理を定義します。
12// このコールバック関数内で Fiber::suspend() を呼び出すことで、
13// ファイバーの実行を一時停止し、呼び出し元に制御を戻します。
14$fiberCallback = function (): void {
15    echo "  [Fiber内部] 処理を開始します。\n";
16
17    // Fiberを一時停止し、呼び出し元に制御を戻します。
18    // suspend() に渡した値は、Fiber::start() または Fiber::resume() の戻り値となります。
19    $messageFromMain = Fiber::suspend("Fiberが一時停止しました。");
20
21    echo "  [Fiber内部] 処理を再開しました。メイン処理から受け取った値: " . $messageFromMain . "\n";
22    echo "  [Fiber内部] 処理を終了します。\n";
23};
24
25// Fiber オブジェクトを作成します。
26$fiber = new Fiber($fiberCallback);
27
28// ファイバー開始前は中断状態ではないことを確認します。
29echo "ファイバー開始前: isSuspended() = " . var_export($fiber->isSuspended(), true) . "\n"; // true (bool) または false (bool)
30
31// ファイバーを実行開始します。
32// ファイバー内の Fiber::suspend() が呼び出されるまで実行され、そこで一時停止します。
33// start() の戻り値は、suspend() に渡された値です。
34$firstMessage = $fiber->start();
35
36// ファイバーが一時停止していることを確認します。
37echo "ファイバー開始後、中断時: isSuspended() = " . var_export($fiber->isSuspended(), true) . "\n"; // true (bool)
38echo "メイン処理: Fiberから受け取ったメッセージ: " . $firstMessage . "\n";
39
40// 中断されたファイバーを再開します。
41// resume() に渡した値は、Fiber::suspend() の戻り値としてファイバー内部で受け取られます。
42// ファイバーは残りの処理を完了します。
43$fiber->resume("メイン処理からFiberへのメッセージ");
44
45// ファイバーが残りの処理を完了し、終了したため、中断状態ではないことを確認します。
46echo "ファイバー再開後、終了時: isSuspended() = " . var_export($fiber->isSuspended(), true) . "\n"; // false (bool)
47echo "ファイバーが完全に終了したか: isTerminated() = " . var_export($fiber->isTerminated(), true) . "\n"; // true (bool)
48
49?>

PHP 8で導入されたFiberクラスのisSuspended()メソッドは、現在操作しているファイバーが一時停止中であるかどうかを判定するために使用します。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。ファイバーがFiber::suspend()メソッドによって中断されている場合にtrueを返し、それ以外の状態、つまりファイバーがまだ開始されていない、実行中である、あるいは既に終了している場合にはfalseを返します。

提供されたサンプルコードでは、まずファイバーが開始される前はisSuspended()がfalseを返します。次に、Fiber::start()で実行が開始され、内部でFiber::suspend()が呼び出されてファイバーが一時停止すると、isSuspended()はtrueを返します。このとき、メイン処理はファイバーからのメッセージを受け取り、ファイバーは中断状態にあります。その後、Fiber::resume()を使ってファイバーの実行を再開し、残りの処理が完了すると、ファイバーは終了状態になり、isSuspended()は再びfalseを返します。このように、isSuspended()はファイバーの実行状態を監視し、非同期処理の制御に役立ちます。

Copy
1<?php
2
3/**
4 * PHP 8 の Fiber::isSuspended() メソッドの動作をデモンストレーションします。
5 *
6 * Fiber (ファイバー) は、PHP 8.1 で導入されたコルーチンに似た機能で、
7 * 処理の実行を中断・再開できることで、非同期処理などを同期的なコードで記述しやすくなります。
8 * Fiber::isSuspended() は、そのファイバーが現在中断状態にあるかどうかを判定します。
9 *
10 * - ファイバー開始前: false
11 * - ファイバーが Fiber::suspend() で中断された直後: true
12 * - ファイバーが終了した後: false
13 *
14 * この関数は、システムエンジニアを目指す初心者の方にも分かりやすいように、
15 * 各ステップでの isSuspended() の結果を表示します。
16 */
17function demonstrateFiberSuspension(): void
18{
19    echo "--- Fiber::isSuspended() のデモンストレーション ---\n\n";
20
21    // 1. Fiber のインスタンスを作成
22    // ここで定義されるクロージャが、ファイバーが実行する処理の内容です。
23    $fiber = new Fiber(function (): void {
24        echo "[Fiber内部] ファイバーを開始しました。\n";
25
26        // ここでファイバーの実行を中断し、呼び出し元に制御を戻します。
27        // この時点で Fiber::isSuspended() は true を返します。
28        Fiber::suspend();
29
30        echo "[Fiber内部] ファイバーが再開されました。\n";
31        echo "[Fiber内部] ファイバーが終了します。\n";
32    });
33
34    echo "ステップ 1: ファイバーのインスタンス作成直後。\n";
35    // ファイバーはまだ開始されていないため、中断状態ではありません。
36    echo "  \$fiber->isSuspended(): " . ($fiber->isSuspended() ? 'true' : 'false') . "\n\n"; // 期待値: false
37
38    // 2. ファイバーの実行を開始
39    // ファイバー内部の Fiber::suspend() まで処理が実行され、そこで中断します。
40    echo "ステップ 2: \$fiber->start() を呼び出し、ファイバーの実行を開始します。\n";
41    $fiber->start();
42
43    echo "ステップ 3: ファイバーが中断されました (Fiber::suspend() 実行後)。\n";
44    // ファイバーは Fiber::suspend() によって中断されているため、true を返します。
45    echo "  \$fiber->isSuspended(): " . ($fiber->isSuspended() ? 'true' : 'false') . "\n\n"; // 期待値: true
46
47    // 3. 中断されたファイバーを再開
48    // ファイバー内部の残りの処理が実行されます。
49    echo "ステップ 4: \$fiber->resume() を呼び出し、中断されたファイバーを再開します。\n";
50    $fiber->resume();
51
52    echo "ステップ 5: ファイバーが終了した後。\n";
53    // ファイバーはすべての処理を完了したため、中断状態ではありません。
54    echo "  \$fiber->isSuspended(): " . ($fiber->isSuspended() ? 'true' : 'false') . "\n"; // 期待値: false
55    // 参考: ファイバーが完全に終了したかどうかは isTerminated() で確認できます。
56    echo "  \$fiber->isTerminated(): " . ($fiber->isTerminated() ? 'true' : 'false') . "\n\n"; // 期待値: true
57
58    echo "--- デモンストレーション終了 ---\n";
59}
60
61// デモンストレーションを実行します。
62demonstrateFiberSuspension();

PHP 8.1で導入されたFiber（ファイバー）は、プログラムの実行を一時停止し、後で再開できる機能です。これにより、非同期処理などをより同期的なコードのように記述しやすくなります。Fiber::isSuspended()メソッドは、このファイバーインスタンスが現在中断状態にあるかどうかを判定するために使用されます。このメソッドは引数を受け取らず、真偽値（bool）を戻り値として返します。中断状態であればtrue、そうでなければfalseです。

サンプルコードでは、Fiber::isSuspended()の挙動を段階的に示しています。まず、ファイバーのインスタンスを作成した直後は、まだ実行が開始されていないため、isSuspended()はfalseを返します。次に$fiber->start()でファイバーを実行し、内部でFiber::suspend()が呼び出されると、ファイバーは一時停止します。この中断状態では、isSuspended()はtrueを返します。最後に$fiber->resume()でファイバーを再開し、すべての処理が完了してファイバーが終了すると、もはや中断状態ではないため、isSuspended()は再びfalseとなります。このように、ファイバーのライフサイクルにおける中断状態を正確に把握するために利用されます。