1
0
mirror of https://github.com/danog/amp.git synced 2024-12-03 09:57:51 +01:00
amp/lib/Pipeline.php
2020-09-24 22:14:58 -05:00

31 lines
765 B
PHP

<?php
namespace Amp;
/**
* A pipeline is an asynchronous set of ordered values.
*
* @template-covariant TValue
*/
interface Pipeline
{
/**
* Succeeds with the emitted value if the pipeline has emitted a value or null if the pipeline has completed.
* If the pipeline fails, the returned promise will fail with the same exception.
*
* @return mixed Returns null if the pipeline has completed.
*
* @psalm-return TValue
*
* @throws \Throwable The exception used to fail the pipeline.
*/
public function continue(): mixed;
/**
* Disposes of the pipeline, indicating the consumer is no longer interested in the pipeline output.
*
* @return void
*/
public function dispose(): void;
}