1
0
mirror of https://github.com/danog/amp.git synced 2024-11-27 04:24:42 +01:00
amp/lib/Stream.php
2017-03-21 18:29:51 +01:00

22 lines
858 B
PHP

<?php
namespace Amp;
/**
* Represents a set of asynchronous values. A stream is analogous to an asynchronous generator, yielding (emitting)
* values when they are available, returning a value (success value) when the stream completes or throwing an
* exception (failure reason).
*/
interface Stream extends Promise {
/**
* Registers a callback to be invoked each time value is emitted from the stream. If the function returns an
* promise, back-pressure is applied to the promise until the returned promise is resolved.
*
* Exceptions thrown from $onEmit (or failures of promises returned from $onNext) will fail the returned
* Subscriber with the thrown exception.
*
* @param callable $onEmit Function invoked each time a value is emitted from the stream.
*/
public function onEmit(callable $onEmit);
}