Runner

Task implementation for executing scheduled callable endpoints.

class Runner extends \Hazaar\Warlock\Agent\Task

Extends: Hazaar\Warlock\Agent\Task

Properties

when

public Cron $when

Type: Hazaar\Util\Cron

interval

public int $interval

Type: int

schedule

public Entry $schedule

Type: Hazaar\Warlock\Agent\Schedule\Entry

occurrence

The scheduled occurrence the next execution represents. This is normally the same as $start, but for a

public int $occurrence

Type: int

catch-up it is the missed occurrence. Retries don't change it.

catchup

True if the next execution is a catch-up of an occurrence missed while the agent was not running.

public bool $catchup

Type: bool

tracking

True while an execution is recorded in the schedule history as running, including its retries.

private bool $tracking

Type: bool

Methods

schedule

Schedules the task.

public schedule(int|string $when, ?int $interval): self

Returns: self

Parameters

Parameter	Type	Description
$when	int	string
$interval	int	with a timestamp, repeat every this many seconds after it

touch

Advances schedule and returns the next run timestamp.

public touch(): ?int

Returns: int

start

Marks task execution start and updates running state metadata.

public start(): void

Returns: void

process

Records how a tracked execution finished, then advances the task as usual.

public process(): self

Returns: self

cancel

Records a tracked execution that is cancelled while it runs, e.g. when the agent shuts down, then cancels it.

public cancel(int $expire = 30): self

Returns: self

Parameters

Parameter	Type	Description
$expire	int

run

public run(): self

Returns: self

processCommand

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

Returns: bool

Parameters

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

---

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