Channel 協程通道

Channel 是協程之間通信的一種機制。一個協程可以將數據推送到通道中,而另一個協程可以從中彈出數據,從而實現協程之間的同步和數據共享。

提示
此特性需要 workerman>=5.1.0

注意

  • 底層自動支持 Swoole/Swow/Fiber/Select/Event 驅動
  • 當使用 Select/Event 驅動時,不支持 pop/push 的超時參數
<?php
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine\Channel;
use Workerman\Coroutine;
use Workerman\Events\Swoole;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';

// Http Server
$worker = new Worker('http://0.0.0.0:8001');
$worker->eventLoop = Swoole::class; // Or Swow::class or Fiber::class
$worker->onMessage = function (TcpConnection $connection, Request $request) {
    $channel = new Channel(2);
    Coroutine::create(function () use ($channel) {
        $channel->push('Task 1 Done');
    });
    Coroutine::create(function () use ($channel) {
        $channel->push('Task 2 Done');
    });
    $result = [];
    for ($i = 0; $i < 2; $i++) {
        $result[] = $channel->pop();
    }
    $connection->send(json_encode($result)); // Response: ["Task 1 Done","Task 2 Done"]
};
Worker::runAll();

接口說明

interface ChannelInterface
{
    /**
     * 將數據推送到通道中,支持超時(單位秒),超時返回 false
     */
    public function push(mixed $data, float $timeout = -1): bool;

    /**
     * 從通道中彈出數據,支持超時(超時單位秒),超時返回 false
     */
    public function pop(float $timeout = -1): mixed;

    /**
     * 獲取通道中數據的長度
     */
    public function length(): int;

    /**
     * 獲取通道的容量
     */
    public function getCapacity(): int;

    /**
     * 是否有消費者,即是否有協程在等待 pop 數據
     */
    public function hasConsumers(): bool;

    /**
     * 是否有生產者,即是否有協程在等待 push 數據到通道
     */
    public function hasProducers(): bool;

    /**
     * 關閉通道
     */
    public function close(): void;

}