Client

Base server-side client connection abstraction.

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

Extends: Hazaar\Warlock\Protocol\WebSockets

Implements: Hazaar\Warlock\Interface\Client

Properties

address

public string $address

Type: string

port

public int $port

Type: int

id

Unique client ID assigned by the server.

public string $id

Type: string

options

Any options passed to the client on creation.

public array $options = array (
  'auth' => true,
  'authMethod' => 'basic',
  'authDb' => NULL,
  'authScript' => NULL,
)

Type: array

type

Current logical client type.

public ClientType $type = 'ClientType'

Type: Hazaar\Warlock\Enum\ClientType

status

The current status of the client.

public ClientStatus $status = 'ClientStatus'

Type: Hazaar\Warlock\Enum\ClientStatus

stream

public mixed $stream

Type: mixed

closing

Indicates websocket close handshake state.

public bool $closing

Type: bool

frameBuffer

public string $frameBuffer

Type: string

payloadBuffer

public string $payloadBuffer

Type: string

name

Human-readable client name label.

public string $name

Type: string

username

public string $username

Type: string

role

What this client may do once authenticated.

public ClientRole $role = 'ClientRole'

Type: Hazaar\Warlock\Server\Enum\ClientRole

The none, list and basic auth methods give an authenticated client ADMIN. The script method gives it USER unless the script returns 'admin' or sets this to ClientRole::ADMIN.

allowSubscribe

public array $allowSubscribe

Type: array

allowTrigger

public array $allowTrigger

Type: array

since

Connection establishment timestamp.

public int $since

Type: int

lastContact

Last contact timestamp from client traffic.

public int $lastContact

Type: int

ping

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

Type: array

offset

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

public int $offset

Type: int

subscriptions

This is an array of eventID and stream pairs.

public array $subscriptions

Type: array

start

Process start timestamp inherited from server runtime.

protected int $start

Type: int

main

Owning server instance.

protected Main $main

Type: Hazaar\Warlock\Server\Main

headers

Any headers sent by the client during handshake will be stored here.

private array $headers

Type: array

Methods

__construct

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

Parameters

Parameter	Type	Description
$main	Hazaar\Warlock\Server\Main
$stream	mixed
$options	array

__destruct

public __destruct(): void

getTypeFromHandshake

public getTypeFromHandshake(string $request): ClientType

Returns: Hazaar\Warlock\Enum\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

Returns: void

Parameters

Parameter	Type	Description
$buf	string

send

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

Returns: bool

Parameters

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

disconnect

Process a stream client disconnect.

public disconnect(): bool

Returns: bool

authorised

public authorised(): bool

Returns: bool

commandUnsubscribe

public commandUnsubscribe(string $eventID): bool

Returns: bool

Parameters

Parameter	Type	Description
$eventID	string

commandTrigger

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

Returns: bool

Parameters

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

sendEvent

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

Returns: bool

Parameters

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

ping

public ping(): bool

Returns: bool

pong

public pong(): void

Returns: void

getHeader

public getHeader(string $name): ?string

Returns: string

Parameters

Parameter	Type	Description
$name	string

parseBasicAuth

Extracts the credentials from an Authorization: Basic header value.

public parseBasicAuth(?string $authorization): ?array

Returns: array

Parameters

Parameter	Type	Description
$authorization	string

authenticate

Authenticates the client with the configured client auth method and updates its status.

public authenticate(string $username, string $password): bool

Returns: bool

The authenticated username is the one supplied, unless it was empty and the auth script set $client->username itself (e.g. from a session cookie). An exception from the auth backend counts as a failure so a broken auth script can't take down the server.

Parameters

Parameter	Type	Description
$username	string
$password	string

checkRequestURL

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

protected checkRequestURL(string $url): array|bool

Returns: array|bool

Parameters

Parameter	Type	Description
$url	string

httpResponse

Generate an HTTP response message.

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

Returns: 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

Returns: bool

Parameters

Parameter	Type	Description
$frame	string

processFrame

Processes a client data frame.

protected processFrame(string $frameBuffer): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$frameBuffer	string

processCommand

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

Returns: bool

Parameters

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

requireAuthorised

Refuses a command from a client that has not authenticated.

protected requireAuthorised(PacketType $command): void

Returns: void

With the none auth method every client is authorised on connect, so this only bites when client auth is enabled. The exception is turned into an ERROR packet by recv() so the client knows to AUTH first.

Parameters

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

requireEventAllowed

Refuses an event ID that isn't in a client's allow-list.

protected requireEventAllowed(?array $allowed, string $eventID, string $action): void

Returns: void

Parameters

Parameter	Type	Description
$allowed	array	the allow-list, or null to allow any event ID
$eventID	string
$action	string

commandAuthenticate

protected commandAuthenticate(\stdClass $payload): bool

Returns: bool

Parameters

Parameter	Type	Description
$payload	stdClass

commandStatus

protected commandStatus(?\stdClass $payload): bool

Returns: bool

Parameters

Parameter	Type	Description
$payload	stdClass

commandSubscribe

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

Returns: bool

Parameters

Parameter	Type	Description
$eventID	string
$filter	array

commandLog

protected commandLog(\stdClass $payload): bool

Returns: bool

Parameters

Parameter	Type	Description
$payload	stdClass

initiateWebSocketsHandshake

Initiates a WebSocket client handshake.

private initiateWebSocketsHandshake(array $headers): bool

Returns: bool

Parameters

Parameter	Type	Description
$headers	array

initiateRESTHandshake

Initiates a REST client handshake.

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

Returns: bool

Parameters

Parameter	Type	Description
$headers	array
$body	string

---

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