コルーチン待機グループ WaitGroup

WaitGroupはBarrierに似た、コルーチンの同期のためのツールであり、非同期タスクにおいてすべてのコルーチンが実行を完了するのを待ってから、後続のロジックを続行できるようにします。

Barrierとの違いは、WaitGroupは開発者が自らカウントの増加と減少を制御できることです。

注意
基本的に自動でドライバタイプを識別し、Swoole/Swow/Fiberドライバのみをサポートします。

ヒント
この機能は workerman>=5.1.0 を必要とします。

<?php
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine\Barrier;
use Workerman\Coroutine;
use Workerman\Events\Swoole;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';

// Http サーバー
$worker = new Worker('http://0.0.0.0:8001');
$worker->eventLoop = Swoole::class; // または Swow::class または Fiber::class
$worker->onMessage = function (TcpConnection $connection, Request $request) {
    $wg = new WaitGroup();
    for ($i=1; $i<5; $i++) {
        $wg->add();
        Coroutine::create(function () use ($wg, $i) {
            try {
            // 何かを実行する
            } finally {
                $wg->done();
            }
        });
    }
    // すべてのコルーチンが完了するのを待つ、10秒後にタイムアウト
    $result = $wg->wait(10.0);
    if (!$result) {
        $connection->send('WaitGroup タイムアウト');
        return;
    }
    $connection->send('すべてのタスクが完了しました');
};

Worker::runAll();

インターフェース説明

interface WaitGroupInterface
{

    /**
     * カウントを増加する
     *
     * @param int $delta
     * @return bool
     */
    public function add(int $delta = 1): bool;

    /**
     * カウントを完了する
     *
     * @return bool
     */
    public function done(): bool;

    /**
     * カウントを返す
     *
     * @return int
     */
    public function count(): int;

    /**
     * コルーチンを待機する
     *
     * @param int|float $timeout 秒
     * @return bool timeout:false 成功:true
     */
    public function wait(int|float $timeout = -1): bool;
}