1
0
mirror of https://github.com/danog/amp.git synced 2024-12-11 17:09:40 +01:00
amp/lib/Pipeline.php

33 lines
889 B
PHP
Raw Normal View History

2020-08-23 16:18:28 +02:00
<?php
namespace Amp;
/**
* A pipeline is an asynchronous set of ordered values.
*
* @template-covariant TValue
*/
interface Pipeline extends \Traversable
2020-08-23 16:18:28 +02:00
{
/**
* Returns the emitted value if the pipeline has emitted a value or null if the pipeline has completed.
* If the pipeline fails, the exception will be thrown from this method.
*
* This method exists primarily for async consumption using Amp\async(fn() => $pipeline->continue()).
2020-08-23 16:18:28 +02:00
*
2020-09-25 05:14:58 +02:00
* @return mixed Returns null if the pipeline has completed.
2020-08-23 16:18:28 +02:00
*
* @psalm-return TValue|null
2020-08-23 16:18:28 +02:00
*
* @throws \Throwable The exception used to fail the pipeline.
*/
2020-09-25 05:14:58 +02:00
public function continue(): mixed;
2020-08-23 16:18:28 +02:00
/**
* Disposes of the pipeline, indicating the consumer is no longer interested in the pipeline output.
*
* @return void
*/
2020-09-24 18:52:22 +02:00
public function dispose(): void;
2020-08-23 16:18:28 +02:00
}