Peer

Server-side client wrapper for cluster peer connections.

class Peer extends \Hazaar\Warlock\Server\Client

Extends: Hazaar\Warlock\Server\Client

Properties

type

Fixed client type for cluster peers.

public ClientType $type = 'ClientType'

Type: Hazaar\Warlock\Enum\ClientType

peerStatus

Current peer connection state.

public PeerStatus $peerStatus = 'PeerStatus'

Type: Hazaar\Warlock\Enum\PeerStatus

identityConfirmed

Whether this peer's real cluster identity has been confirmed via PEERINFO (as opposed

public bool $identityConfirmed

Type: bool

to still carrying the meaningless per-socket default $name from Client::__construct()). Set by Cluster::processCommand() once it re-keys this peer under its real name.

reconnectTimeout

Minimum seconds between reconnect attempts.

private int $reconnectTimeout = 15

Type: int

lastConnectAttempt

Timestamp of the most recent connect attempt.

private int $lastConnectAttempt

Type: int

Methods

__construct

public __construct(Main $main, mixed $stream, ?array $options): void

Parameters

Parameter	Type	Description
$main	Hazaar\Warlock\Server\Main	server runtime instance
$stream	mixed	existing stream resource, if any
$options	array	peer/client options

__destruct

Emits peer destruction diagnostics.

public __destruct(): void

initiateHandshake

Handles websocket handshake initiation for inbound peer connections.

public initiateHandshake(string $request, array $headers): bool

Returns: bool

The peer must present the cluster access key (and the cluster name, when one is configured) before the WebSocket upgrade is accepted, so a rejected peer never sees a 101.

Parameters

Parameter	Type	Description
$request	string
$headers	array

process

Advances peer connection state machine and IO handling.

public process(): void

Returns: void

recv

Processes incoming data according to current peer status phase.

public recv(string $buf): void

Returns: void

Parameters

Parameter	Type	Description
$buf	string

status

Returns human-readable peer status text.

public status(): string

Returns: string

connect

Initiates asynchronous TCP connection to configured peer endpoint.

public connect(): bool

Returns: bool

disconnect

public disconnect(): bool

Returns: bool

isConnected

public isConnected(): bool

Returns: bool

sendEvent

public sendEvent(string $eventID, string $triggerID, mixed $data): bool

Returns: bool

Parameters

Parameter	Type	Description
$eventID	string
$triggerID	string
$data	mixed

processCommand

protected processCommand(PacketType $command, mixed $payload): bool

Returns: bool

Parameters

Parameter	Type	Description
$command	Hazaar\Warlock\Enum\PacketType
$payload	mixed

announceIdentity

Announces this server's own identity to the peer at the other end of this connection.

private announceIdentity(): void

Returns: void

Called by both the dialer and the acceptor as soon as their own side of the handshake completes, making identity exchange symmetric - see Cluster::processCommand()'s PEERINFO handling, which is what re-keys the corresponding Peer object on the receiving end.

---

Generated by Hazaar API Doc Generator on Thu, 22 Oct 2026 05:05:31 +0000