Process

About 5 min

Process

Base process implementation for Warlock clients, agents, and services.

class Process

Properties

instances

public array $instances

start

Process start timestamp.

public int $start

state

Current lifecycle state for the process.

public Status $state = 'Status'

protocol

Protocol encoder/decoder used for connection packets.

public Protocol $protocol

conn

Active transport connection implementation.

protected Connection $conn

reconnect

Whether process should reconnect when a connection drops.

protected bool $reconnect

id

public string $id

clientId

public string $clientId

subscriptions

protected array $subscriptions

slept

Indicates whether sleep() executed in the current run loop.

protected bool $slept

silent

Suppresses selected runtime logging when true.

protected bool $silent

log

Logger instance for process diagnostics.

protected Logger $log

messageQueue

A queue of messages to send when the connection is established. This allows messages

private array $messageQueue

to be sent before the connection is ready, which is useful for services that need to trigger events or set keys on startup.

Methods

__construct

public __construct(Protocol $protocol): void

Parameters

Parameter	Type	Description
`$protocol`	`Protocol`	protocol encoder/decoder instance

__destruct

Ensures transport disconnect on process cleanup.

public __destruct(): void

__errorHandler

public __errorHandler(int $errno, string $errstr, ?string $errfile, ?int $errline, array $errcontext): bool

Parameters

Parameter	Type	Description
`$errno`	`int`
`$errstr`	`string`
`$errfile`	`string`
`$errline`	`int`
`$errcontext`	`array`

__exceptionHandler

public __exceptionHandler(\Throwable $e): void

Parameters

Parameter	Type	Description
`$e`	`\Throwable`

__signalHandler

Shared process signal handler for registered process instances.

public __signalHandler(int $signo, mixed $siginfo): void

Parameters

Parameter	Type	Description
`$signo`	`int`	POSIX signal number
`$siginfo`	`mixed`	optional signal metadata

__kv_send_recv

private __kv_send_recv(PacketType $command, array $data): mixed

Parameters

Parameter	Type	Description
`$command`	`PacketType`
`$data`	`array`

construct

Constructor placeholder for child classes.

public construct(Application $app): void

Parameters

Parameter	Type	Description
`$app`	`Application`

init

Initialisation placeholder for child classes.

public init(): bool

id

public id(): ?string

send

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

Parameters

Parameter	Type	Description
`$command`	`PacketType`
`$payload`	`mixed`

recv

public recv(mixed $payload, int $tvSec = 3, int $tvUsec): null

Parameters

Parameter	Type	Description
`$payload`	`mixed`
`$tvSec`	`int`
`$tvUsec`	`int`

ping

public ping(bool $waitPong): string

Parameters

Parameter	Type	Description
`$waitPong`	`bool`

on

public on(string $event, callable $callable, ?array $filter): bool

Parameters

Parameter	Type	Description
`$event`	`string`
`$callable`	`callable`
`$filter`	`array`

public subscribe(string $event, callable $callable, ?array $filter): bool

Parameters

Parameter	Type	Description
`$event`	`string`
`$callable`	`callable`
`$filter`	`array`

addEventEndpoint

public addEventEndpoint(string $event, Endpoint $endpoint): bool

Parameters

Parameter	Type	Description
`$event`	`string`
`$endpoint`	`Endpoint`

unsubscribe

public unsubscribe(string $event): bool

Parameters

Parameter	Type	Description
`$event`	`string`

trigger

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

Parameters

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

log

public log(string $message, LogLevel $level = 'LogLevel::NOTICE', ?string $name): bool

Parameters

Parameter	Type	Description
`$message`	`string`
`$level`	`LogLevel`
`$name`	`string`

debug

public debug(mixed $data, ?string $name): bool

Parameters

Parameter	Type	Description
`$data`	`mixed`
`$name`	`string`

spawn

public spawn(string $service, array $params): bool

Parameters

Parameter	Type	Description
`$service`	`string`
`$params`	`array`

kill

public kill(string $service): bool

Parameters

Parameter	Type	Description
`$service`	`string`

status

public status(): \stdClass

exec

public exec(callable $callable, array $params, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$callable`	`callable`	this can be a string in the format 'Class::method' or a callable function
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

execDelay

public execDelay(int $delay, callable $callable, array $params, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$delay`	`int`
`$callable`	`callable`	this can be a string in the format 'Class::method' or a callable function
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

interval

public interval(int $seconds, string $callable, array $params, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$seconds`	`int`
`$callable`	`string`
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

schedule

public schedule(DateTime $when, string $callable, array $params, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$when`	`DateTime`
`$callable`	`string`
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

cancelTask

public cancelTask(string $taskID): bool

Parameters

Parameter	Type	Description
`$taskID`	`string`

startService

public startService(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

stopService

public stopService(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

service

public service(string $name): string

Parameters

Parameter	Type	Description
`$name`	`string`

get

public get(string $key, ?string $namespace): mixed

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

set

public set(string $key, mixed $value, ?int $timeout, ?string $namespace): bool

Parameters

Parameter	Type	Description
`$key`	`string`
`$value`	`mixed`
`$timeout`	`int`
`$namespace`	`string`

has

public has(string $key, ?string $namespace): bool

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

del

public del(string $key, ?string $namespace): bool

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

clear

public clear(?string $namespace): bool

Parameters

Parameter	Type	Description
`$namespace`	`string`

List all keys in the key-value store.

public (?string $namespace): void

If a namespace is provided, it will list keys only in that namespace.

Parameters

Parameter	Type	Description
`$namespace`	`string`

pull

public pull(string $key, ?string $namespace): mixed

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

push

public push(string $key, mixed $value, ?string $namespace): bool

Parameters

Parameter	Type	Description
`$key`	`string`
`$value`	`mixed`
`$namespace`	`string`

pop

public pop(string $key, ?string $namespace): mixed

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

shift

public shift(string $key, ?string $namespace): mixed

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

unshift

public unshift(string $key, mixed $value, ?string $namespace): bool

Parameters

Parameter	Type	Description
`$key`	`string`
`$value`	`mixed`
`$namespace`	`string`

incr

public incr(string $key, ?int $step, ?string $namespace): int

Parameters

Parameter	Type	Description
`$key`	`string`
`$step`	`int`
`$namespace`	`string`

decr

public decr(string $key, ?int $step, ?string $namespace): int

Parameters

Parameter	Type	Description
`$key`	`string`
`$step`	`int`
`$namespace`	`string`

keys

Get all keys in the key-value store.

public keys(?string $namespace): void

If a namespace is provided, it will return keys only in that namespace.

Parameters

Parameter	Type	Description
`$namespace`	`string`

vals

Get all values in the key-value store.

public vals(?string $namespace): void

If a namespace is provided, it will return values only in that namespace.

Parameters

Parameter	Type	Description
`$namespace`	`string`

count

Count the number of keys in the key-value store.

public count(string $key, ?string $namespace): int

If a namespace is provided, it will count keys only in that namespace.

Parameters

Parameter	Type	Description
`$key`	`string`
`$namespace`	`string`

connect

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

Parameters

Parameter	Type	Description
`$username`	`string`
`$password`	`string`

disconnect

public disconnect(): bool

connected

public connected(): bool

ready

public ready(): bool

authenticated

public authenticated(): bool

authenticate

public authenticate(string $username, string $password): bool

Parameters

Parameter	Type	Description
`$username`	`string`
`$password`	`string`

main

public main(?array $params, bool $dynamic): int

Parameters

Parameter	Type	Description
`$params`	`array`
`$dynamic`	`bool`

shutdown

public shutdown(): void

cancel

public cancel(): void

stop

public stop(bool $force, ?string $pid): bool

Parameters

Parameter	Type	Description
`$force`	`bool`
`$pid`	`string`

state

public state(): Status

run

protected run(): void

sleep

Sleep for a number of seconds. If data is received during the sleep it is processed. If the timeout is greater

protected sleep(int $timeout, Status $checkStatus = 'Status::RUNNING', ?callable $iterationCallback): bool

than zero and data is received, the remaining timeout amount will be used in subsequent selects to ensure the full sleep period is used. If the timeout parameter is not set then the loop will just dump out after one execution.

Parameters

Parameter	Type	Description
`$timeout`	`int`	number of seconds to sleep for
`$checkStatus`	`Status`	the status to check for when sleeping. If the process status changes from this value, the sleep will end early.
`$iterationCallback`	`callable`	an optional callback that is executed at the end of each sleep iteration. This can be used to perform regular checks or maintenance tasks during long sleep periods.

createConnection

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

Parameters

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

setErrorHandler

protected setErrorHandler(string $methodName): void

Parameters

Parameter	Type	Description
`$methodName`	`string`

setExceptionHandler

protected setExceptionHandler(string $methodName): void

Parameters

Parameter	Type	Description
`$methodName`	`string`

processCommand

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

Parameters

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

sendExec

private sendExec(string $command, mixed $data, callable $callable, ?array $params, ?string $tag, bool $overwrite): string

Parameters

Parameter	Type	Description
`$command`	`string`
`$data`	`mixed`
`$callable`	`callable`	this can be a string in the format 'Class::method' or a callable function
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

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