Protocol

Hazaar Application Protocol Class

class Protocol

The Application Protocol is a simple protocol developed to allow communication between parts of the Hazaar framework over the wire or other IO interfaces. It allows common information to be encoded/decoded between endpoints.

Properties

sid

Server identifier included in encoded packets.

private string $sid

lastError

Last decode/validation error.

private string $lastError

encoded

Whether payloads are base64-encoded over the transport.

private bool $encoded = true

Methods

__construct

public __construct(string $sid, bool $encoded = true): void

Parameters

Parameter	Type	Description
$sid	string	server identifier
$encoded	bool	whether packets are base64-wrapped

getLastError

Returns the most recent protocol error message.

public getLastError(): string

encoded

Returns whether packet encoding is enabled.

public encoded(): bool

encode

Encodes a packet type and optional payload for transport.

public encode(PacketType $type, mixed $payload): string

Parameters

Parameter	Type	Description
$type	PacketType
$payload	mixed

decode

Decodes a raw packet string and extracts type/payload/timestamp.

public decode(string $packet, mixed $payload, ?int $time): null

Parameters

Parameter	Type	Description
$packet	string	raw packet buffer
$payload	mixed	output payload
$time	int	output packet timestamp

error

Stores and returns a protocol error sentinel.

private error(string $msg): false

Parameters

Parameter	Type	Description
$msg	string

---

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