Client

Control class for Warlock

class Client extends \Hazaar\Warlock\Process

This class creates a connection to the Warlock server from within a Hazaar application allowing the application to send triggers or schedule tasks for delayed execution.

Properties

config

public array $config

Methods

__construct

public __construct(array $clientConfig): void

Parameters

Parameter	Type	Description
$clientConfig	array

connect

public connect(?string $username, ?string $password): bool

Parameters

Parameter	Type	Description
$username	string
$password	string

wait

Waits for a command to be received from the server and processes it.

public wait(int $seconds): bool

This is used in cases where the client needs to wait for a response from the server after sending a trigger or scheduling a task. If the server does not respond within the specified timeout, this method will return false.

Parameters

Parameter	Type	Description
$seconds	int	socket receive timeout in seconds

createConnection

Creates the default socket connection for this client process.

protected createConnection(Protocol $protocol, ?string $guid): void

Parameters

Parameter	Type	Description
$protocol	Protocol	protocol encoder/decoder
$guid	string	optional connection identifier

processCommand

protected processCommand(PacketType $command, ?\stdClass $payload): bool

Parameters

Parameter	Type	Description
$command	PacketType
$payload	\stdClass

---

Generated by Hazaar API Doc Generator on Fri, 05 Jun 2026 06:08:15 +0000