ResponseBody

API reference › RoadRunner › ResponseBody

final class	`yii2\extensions\roadrunner\ResponseBody`
Implements	`Psr\Http\Message\StreamInterface`
Source	`src/ResponseBody.php`

Retains failures from streaming read() and eof() calls that an emitter may consume.

Methods

Method	Description	Defined by
`__construct()`		`ResponseBody`
`__toString()`		`ResponseBody`
`close()`		`ResponseBody`
`detach()`		`ResponseBody`
`eof()`		`ResponseBody`
`getContents()`		`ResponseBody`
`getFailure()`	Returns the failure even when the emitter returned normally after consuming it.	`ResponseBody`
`getMetadata()`		`ResponseBody`
`getSize()`		`ResponseBody`
`isReadable()`		`ResponseBody`
`isSeekable()`		`ResponseBody`
`isWritable()`		`ResponseBody`
`read()`		`ResponseBody`
`rewind()`		`ResponseBody`
`seek()`		`ResponseBody`
`tell()`		`ResponseBody`
`write()`		`ResponseBody`

Method details

__construct()

public function __construct(Psr\Http\Message\StreamInterface $stream)

Parameters

Parameter	Type	Description
`$stream`	`Psr\Http\Message\StreamInterface`

__toString()

public function __toString(): string

Returns

string

close()

public function close(): void

detach()

public function detach(): resource|null

Returns

resource|null

eof()

public function eof(): bool

Returns

bool

getContents()

public function getContents(): string

Returns

string

getFailure()

public function getFailure(): Throwable|null

Returns the failure even when the emitter returned normally after consuming it.

Returns

Throwable|null

getMetadata()

public function getMetadata(string|null $key = null): mixed

Parameters

Parameter	Type	Description
`$key`	`string\|null`

Returns

mixed

getSize()

public function getSize(): int|null

Returns

int|null

isReadable()

public function isReadable(): bool

Returns

bool

isSeekable()

public function isSeekable(): bool

Returns

bool

isWritable()

public function isWritable(): bool

Returns

bool

read()

public function read(int $length): string

Parameters

Parameter	Type	Description
`$length`	`int`

Returns

string

rewind()

public function rewind(): void

seek()

public function seek(int $offset, int $whence = \yii2\extensions\roadrunner\SEEK_SET): void

Parameters

Parameter	Type	Description
`$offset`	`int`
`$whence`	`int`

tell()

public function tell(): int

Returns

int

write()

public function write(string $string): int

Parameters

Parameter	Type	Description
`$string`	`string`

Returns

int