Stream

Stream response class.

class Stream extends \Hazaar\Controller\Response\OK

This response emits lightweight framed stream packets for incremental output. Payloads can represent plain strings, arrays encoded as JSON, or exception details encoded as structured error packets.

Packet framing uses a one-byte type marker and content payload, with writePacket() additionally prefixing a hexadecimal payload length.

Properties

type

Stream packet type marker.

private string $type = 's'

Known values are:

• s for plain string payloads
• a for array/JSON payloads
• e for error payloads

Methods

__construct

public __construct(string $data): void

Parameters

Parameter	Type	Description
$data	string

writePacket

Write a framed stream packet with a hexadecimal length prefix.

public writePacket(): void

Packet format: <hex-length>\0<type><payload>. The output buffers are flushed immediately to support streaming clients.

writeOutput

Write the stream payload without a length prefix.

public writeOutput(): void

Packet format: \0<type><payload>.

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000