Task

Base class for executable tasks managed by the agent.

class Task extends \Hazaar\Warlock\Agent\Process

Extends: Hazaar\Warlock\Agent\Process

Properties

status

Current task lifecycle status.

public TaskStatus $status = 'TaskStatus'

Type: Hazaar\Warlock\Enum\TaskStatus

agent

Owning agent process.

public Main $agent

Type: Hazaar\Warlock\Agent\Main

start

Next scheduled execution timestamp.

public int $start

Type: int

retries

Number of retry attempts already consumed.

public int $retries

Type: int

expire

Expiration timestamp after completion/cancellation.

public int $expire

Type: int

timeout

Max runtime timeout in seconds.

public int $timeout

Type: int

respawn

Whether the task should be respawned after completion.

public bool $respawn

Type: bool

respawnDelay

Delay in seconds before respawn.

public int $respawnDelay

Type: int

lastHeartbeat

Timestamp of the last heartbeat received.

public int $lastHeartbeat

Type: int

heartbeats

Number of heartbeats received.

public int $heartbeats

Type: int

config

public array $config

Type: array

Configuration for the task, such as retry count, retry delay, and expiration time.

endpoint

Endpoint definition to execute for this task.

public Endpoint $endpoint

Type: Hazaar\Warlock\Agent\Struct\Endpoint

isErrorHandler

Whether this task is itself an error handler, scheduled in response to another

public bool $isErrorHandler

Type: bool

task's failure. Prevents runaway recursion if the error handler also fails.

params

protected array $params

Type: array

recvBuffer

Buffered receive data awaiting full packet extraction.

private string $recvBuffer

Type: string

subscriptions

private array $subscriptions

Type: array

Methods

__construct

public __construct(Main $agent, Logger $log): void

Parameters

Parameter	Type	Description
$agent	Hazaar\Warlock\Agent\Main	owning agent process
$log	Hazaar\Warlock\Logger	task logger

exec

Executes the task with the given callable and parameters.

public exec(Endpoint $endpoint, mixed $params): self

Returns: self

Parameters

Parameter	Type	Description
$endpoint	Hazaar\Warlock\Agent\Struct\Endpoint
$params	mixed

ready

Returns true when the task is queued and ready to start.

public ready(): bool

Returns: bool

start

Starts child process execution for this task.

public start(): void

Returns: void

process

Advances task state machine and runtime monitoring.

public process(): self

Returns: self

run

Default run implementation for tasks that do not override execution.

public run(): self

Returns: self

cancel

Cancels task execution and schedules task expiry.

public cancel(int $expire = 30): self

Returns: self

Parameters

Parameter	Type	Description
$expire	int

expired

Returns true when task is eligible for queue cleanup.

public expired(): bool

Returns: bool

recv

Consumes inbound data buffer and processes decoded packets.

public recv(string $buf): self

Returns: self

Parameters

Parameter	Type	Description
$buf	string

destruct

public destruct(): void

Returns: void

touch

Returns the next scheduled timestamp for this task.

public touch(): ?int

Returns: int

timeout

Returns true when runtime has exceeded configured timeout.

public timeout(): bool

Returns: bool

send

Encodes and writes a packet to the child process.

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

Returns: bool

Parameters

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

getEndpoint

public getEndpoint(): Endpoint

Returns: Hazaar\Warlock\Agent\Struct\Endpoint

processCommand

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

Returns: bool

Parameters

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

commandTrigger

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

Returns: bool

Parameters

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

commandSubscribe

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

Returns: bool

Parameters

Parameter	Type	Description
$eventID	string
$filter	array

commandUnsubscribe

private commandUnsubscribe(string $eventID): bool

Returns: bool

Parameters

Parameter	Type	Description
$eventID	string

commandLog

private commandLog(\stdClass $payload): bool

Returns: bool

Parameters

Parameter	Type	Description
$payload	stdClass

monitor

private monitor(): void

Returns: void

processPacket

private processPacket(?string $buffer): false|string

Returns: false|string

Parameters

Parameter	Type	Description
$buffer	string

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:17 +0000