Client

Base server-side client connection abstraction.

class Client extends \Hazaar\Warlock\Server\WebSockets implements \Hazaar\Warlock\Interface\Client

Properties

address

public string $address

port

public int $port

id

Unique client ID assigned by the server.

public string $id

type

Current logical client type.

public ClientType $type = 'ClientType'

stream

public mixed $stream

closing

Indicates websocket close handshake state.

public bool $closing

frameBuffer

public string $frameBuffer

payloadBuffer

public string $payloadBuffer

name

Human-readable client name label.

public string $name

username

public string $username

since

Connection establishment timestamp.

public int $since

lastContact

Last contact timestamp from client traffic.

public int $lastContact

ping

public array $ping = array (
  'attempts' => 0,
  'last' => 0,
  'retry' => 5,
  'retries' => 3,
)

offset

Any detected time offset. This doesn't need to be exact so we don't bother worrying about latency.

public int $offset

subscriptions

This is an array of eventID and stream pairs.

public array $subscriptions

start

Process start timestamp inherited from server runtime.

protected int $start

main

Owning server instance.

protected Main $main

Methods

__construct

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

Parameters

Parameter	Type	Description
$main	Main
$stream	mixed
$options	array

__destruct

public __destruct(): void

getTypeFromHandshake

public getTypeFromHandshake(string $request): ClientType

Parameters

Parameter	Type	Description
$request	string

initiateHandshake

Initiates the handshake for an agent client.

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

Parameters

Parameter	Type	Description
$request	string	the request string from the client
$headers	array	reference to an array where headers will be stored

recv

public recv(string $buf): void

Parameters

Parameter	Type	Description
$buf	string

send

public send(PacketType $command, mixed $payload): bool

Parameters

Parameter	Type	Description
$command	PacketType
$payload	mixed

disconnect

Process a stream client disconnect.

public disconnect(): bool

authenticated

public authenticated(): bool

commandUnsubscribe

public commandUnsubscribe(string $eventID): bool

Parameters

Parameter	Type	Description
$eventID	string

commandTrigger

public commandTrigger(string $eventID, mixed $data, bool $echoClient = true): bool

Parameters

Parameter	Type	Description
$eventID	string
$data	mixed
$echoClient	bool

sendEvent

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

Parameters

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

ping

public ping(): bool

pong

public pong(): void

checkRequestURL

Overridden method from WebSocket class to check the requested WebSocket URL is valid.

protected checkRequestURL(string $url, bool $): void

Parameters

Parameter	Type	Description
$url	string
$	bool

httpResponse

Generate an HTTP response message.

protected httpResponse(int $code, ?string $body, array $headers): string

Parameters

Parameter	Type	Description
$code	int	HTTP response code
$body	string	The response body
$headers	array	Additional headers

write

protected write(string $frame): bool

Parameters

Parameter	Type	Description
$frame	string

processFrame

Processes a client data frame.

protected processFrame(string $frameBuffer): mixed

Parameters

Parameter	Type	Description
$frameBuffer	string

processCommand

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

Parameters

Parameter	Type	Description
$command	PacketType
$payload	mixed

commandAuthenticate

protected commandAuthenticate(\stdClass $payload, bool $service): bool

Parameters

Parameter	Type	Description
$payload	\stdClass
$service	bool

commandStatus

protected commandStatus(?\stdClass $payload): bool

Parameters

Parameter	Type	Description
$payload	\stdClass

commandSubscribe

protected commandSubscribe(string $eventID, ?array $filter): bool

Parameters

Parameter	Type	Description
$eventID	string
$filter	array

commandLog

protected commandLog(\stdClass $payload): bool

Parameters

Parameter	Type	Description
$payload	\stdClass

initiateWebSocketsHandshake

Initiates a WebSocket client handshake.

private initiateWebSocketsHandshake(array $headers): bool

Parameters

Parameter	Type	Description
$headers	array

initiateRESTHandshake

Initiates a REST client handshake.

private initiateRESTHandshake(array $headers, string $body): bool

Parameters

Parameter	Type	Description
$headers	array
$body	string

---

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