Skip to main content

Stream

Overview​

Stream in ripple is an event-based data stream, which can be used to process large amounts of data, such as file reading, network requests, etc. All Streams implement StreamInterface under the PSR specification, and also encapsulate multiple commonly used monitoring stream methods such as

Subscribed readable and writable events, all closures are in the event runtime context, and the closure will receive two parameters

  • Stream $stream current stream object
  • Closure $cancel cancels the subscription closure
Closure(Stream $stream,Closure $cancel);

Subscribe to readable events​

public function onReadable(Closure $closure): string;

$stream = \Co\IO::File()->open('file.txt');
$stream->onReadable(function (Stream $stream,Closure $cancel) {
    $data = $stream->read(1024);
    echo $data .PHP_EOL;
    
    //Cancel subscription
    $cancel();
});

Subscribe to writable events​

public function onWritable(Closure $closure): string;

Subscribe to the closing event​

public function onClose(Closure $closure): void;

Notes​

A stream allows multiple subscriptions to exist at the same time, and they will all be executed, but for read/write operations, There is usually no point in doing this because the first subscriber will consume the data, making subsequent subscribers unable to read the data.