Task

Base class for executable tasks managed by the agent.

class Task extends \Hazaar\Warlock\Agent\Process

Properties

status

Current task lifecycle status.

public TaskStatus $status = 'TaskStatus'

agent

Owning agent process.

public Main $agent

start

Next scheduled execution timestamp.

public int $start

retries

Number of retry attempts already consumed.

public int $retries

expire

Expiration timestamp after completion/cancellation.

public int $expire

timeout

Max runtime timeout in seconds.

public int $timeout

respawn

Whether the task should be respawned after completion.

public bool $respawn

respawnDelay

Delay in seconds before respawn.

public int $respawnDelay

lastHeartbeat

Timestamp of the last heartbeat received.

public int $lastHeartbeat

heartbeats

Number of heartbeats received.

public int $heartbeats

config

public array $config

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

endpoint

Endpoint definition to execute for this task.

public Endpoint $endpoint

params

protected array $params

recvBuffer

Buffered receive data awaiting full packet extraction.

private string $recvBuffer

subscriptions

private array $subscriptions

Methods

__construct

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

Parameters

Parameter	Type	Description
$agent	Main	owning agent process
$log	Logger	task logger

exec

Executes the task with the given callable and parameters.

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

Parameters

Parameter	Type	Description
$endpoint	Endpoint
$params	mixed

ready

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

public ready(): bool

start

Starts child process execution for this task.

public start(): void

process

Advances task state machine and runtime monitoring.

public process(): self

run

Default run implementation for tasks that do not override execution.

public run(): self

cancel

Cancels task execution and schedules task expiry.

public cancel(int $expire = 30): self

Parameters

Parameter	Type	Description
$expire	int

expired

Returns true when task is eligible for queue cleanup.

public expired(): bool

recv

Consumes inbound data buffer and processes decoded packets.

public recv(string $buf): self

Parameters

Parameter	Type	Description
$buf	string

destruct

public destruct(): void

touch

Returns the next scheduled timestamp for this task.

public touch(): ?int

timeout

Returns true when runtime has exceeded configured timeout.

public timeout(): bool

send

Encodes and writes a packet to the child process.

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

Parameters

Parameter	Type	Description
$command	PacketType
$payload	mixed

getEndpoint

public getEndpoint(): Endpoint

processCommand

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

Parameters

Parameter	Type	Description
$command	PacketType
$payload	mixed

commandTrigger

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

Parameters

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

commandSubscribe

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

Parameters

Parameter	Type	Description
$eventID	string
$filter	array

commandUnsubscribe

private commandUnsubscribe(string $eventID): bool

Parameters

Parameter	Type	Description
$eventID	string

commandLog

private commandLog(\stdClass $payload): bool

Parameters

Parameter	Type	Description
$payload	\stdClass

monitor

private monitor(): void

processPacket

private processPacket(?string $buffer): string

Parameters

Parameter	Type	Description
$buffer	string

---

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