Main

About 2 min

Main

Main Warlock agent process responsible for task orchestration.

class Main extends \Hazaar\Warlock\Agent\Process

Properties

tasks

Main task queue.

public array $tasks

reconnect

Reconnect automatically when control channel is interrupted.

protected bool $reconnect = true

config

Agent configuration loaded from environment and config files.

private Config $config

app

Application metadata used by spawned task processes.

private Application $app

Methods

__construct

public __construct(?string $configFile, string $env = 'development'): void

Parameters

Parameter	Type	Description
`$configFile`	`string`	agent config filename
`$env`	`string`	runtime environment name

getConfig

Returns the agent configuration.

public getConfig(): Config

setSilent

Enables or disables agent log output.

public setSilent(bool $silent = true): void

Parameters

Parameter	Type	Description
`$silent`	`bool`

createConnection

Creates the agent control-channel socket connection.

public createConnection(Protocol $protocol, ?string $guid): Connection

Parameters

Parameter	Type	Description
`$protocol`	`Protocol`
`$guid`	`string`

bootstrap

Performs one-time agent setup before entering the run loop.

public bootstrap(): self

registerServices

Loads and registers service tasks from a services config file.

public registerServices(string $configFile = 'services'): void

Parameters

Parameter	Type	Description
`$configFile`	`string`

registerScheduledTasks

Registers scheduled tasks based on the provided configuration array.

public registerScheduledTasks(array $scheduleConfig): void

Iterates through each task in the schedule configuration, validates the presence of the 'action' attribute, creates an Endpoint for the action, sets parameters if provided, and schedules the task to run at the specified time. Handles special scheduling keyword '@reboot' by calculating the appropriate start time with an optional boot delay. Logs notices and errors for missing or invalid configuration attributes.

Parameters

Parameter	Type	Description
`$scheduleConfig`	`array`

registerEventHandlers

Registers event handlers based on the provided configuration array.

public registerEventHandlers(array $eventConfig): void

Iterates through each event in the event configuration, creates an Endpoint for the handler, and subscribes to the event with the corresponding handler. Logs notices and errors for invalid configuration attributes.

Parameters

Parameter	Type	Description
`$eventConfig`	`array`	array of event configurations where the key is the event name and the value is the handler (callable)

shutdown

public shutdown(): void

init

public init(): bool

announce

public announce(): void

trigger

public trigger(string $event, mixed $data, bool $echoSelf): bool

Parameters

Parameter	Type	Description
`$event`	`string`
`$data`	`mixed`
`$echoSelf`	`bool`

run

protected run(): void

processCommand

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

Parameters

Parameter	Type	Description
`$command`	`PacketType`
`$payload`	`\stdClass`

processEvent

private processEvent(string $event, mixed $payload): void

Parameters

Parameter	Type	Description
`$event`	`string`
`$payload`	`mixed`

scheduleRunner

private scheduleRunner(string $when, Endpoint $endpoint, mixed $args, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$when`	`string`
`$endpoint`	`Endpoint`
`$args`	`mixed`
`$tag`	`string`
`$overwrite`	`bool`

taskQueueAdd

private taskQueueAdd(Task $task): void

Parameters

Parameter	Type	Description
`$task`	`Task`

taskCancel

private taskCancel(string $taskID): bool

Parameters

Parameter	Type	Description
`$taskID`	`string`

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