`phasync\Psr\UnbufferedStream` class

Show private and protected members

Documentation

Unbuffered streaming PSR-7 StreamInterface

Designed for returning a response which has not been completed yet. A coroutine can continue appending to the stream.

Usage:

$s = new UnbufferedStream();

// Create a coroutine which appends to the stream
phasync::go(function() use ($s) {
    // Append chunks as much as you need
    $s->append("A chunk");

    // Signal that the stream is complete
    $s->end();
});

// Return the stream
return $response->withStream($s);

By default the stream will buffer up to 64 KB of data, to improve performance and reduce context switching.

Inheritance

Implements: Psr\Http\Message\StreamInterface Stringable

Properties (11)

private string $buffer

The string buffer

private int $bufferSize

private int $readOffset

private float $deadlockTimeout

private bool $closed

private bool $ended

private bool $locked

private bool $detached

private WeakReference $creator

private object $readFlag

private object $writeFlag

Methods (18)

public `__construct()`

Documentation missing

public `__toString()`

Documentation missing

public `close()`

Documentation missing

public `detach()`

Documentation missing

public `getSize()`

Documentation missing

public `tell()`

Documentation missing

public `eof()`

Documentation missing

public `isSeekable()`

Documentation missing

public `seek()`

Documentation missing

public `rewind()`

Documentation missing

public `isWritable()`

Documentation missing

public `write()`

Documentation missing

public `isReadable()`

Documentation missing

public `read()`

Documentation missing

public `getContents()`

Documentation missing

public `getMetadata()`

Documentation missing

public `append()`

Append more data to the stream

public `end()`

Inform that no more content will be appended to the stream,

Source

src/Psr/UnbufferedStream.php:37-234