Swoole\Coroutine\Channel->push()

1. Swoole
2. Swoole Docs
3. Channel
4. Swoole\Coroutine\Channel->push()

Swoole Coroutine Channel Push

Declaration

<?php
Swoole\Coroutine\Channel->push(mixed $data, float $timeout = -1): bool

Parameters

data

The data you want to add to the channel stack, can be any PHP variable, including anonymous functions and resources.

timeout

Sets the timeout period for when the channel is full, false will be returned if the timeout is reached

Return

A successful push will return true and a closed channel or timeout will return false.

Description

Writes data to the channel.

Quick Usage Example

Wait and push one element into the queue of the channel.

<?php

$chan = new Swoole\Coroutine\Channel(1);

Co\run(function () use ($chan) {
    $cid = Swoole\Coroutine::getuid();
    $i = 0;
    while (1) {
        co::sleep(1.0);
        $chan->push(['rand' => rand(1000, 9999), 'index' => $i]);
        echo "[coroutine $cid] - $i\n";
        $i++;
    }
});

Co\run(function () use ($chan) {
    $cid = Swoole\Coroutine::getuid();
    while(1) {
        $data = $chan->pop();
        echo "[coroutine $cid]\n";
        var_dump($data);
    }
});

Notes

Coroutine channels use local memory, memory is isolated between different processes. Only in same process push and pop operations work with different coroutines.

You can use $channel->errCode to access the error code for more detail on what happened.

To avoid ambiguity, do not write data into an empty channel that could be classed as an error, such as 0, false, an empty string or null.