Service

About 2 min

Service

The Warlock application service class

Services are long running processes that allow code to be executed on the server in the background without affecting or requiring any interaction with the front-end. Services are managed by the Warlock process and can be set to start when Warlock starts or enabled/disabled manually using the Hazaar\Warlock\Control class.

Services are executed within the Application context and therefore have access to everything (configs, classes/models, cache, etc) that your application front-end does.

See the "Services Documentation":https://scroly.io/hazaarmvc/advanced-features/warlock/services for information on how to write and manage services.

Properties

name

protected string $name

config

protected array $config

schedule

protected array $schedule

next

public int $next

slept

protected bool $slept

lastHeartbeat

private int $lastHeartbeat

lastCheckfile

private int $lastCheckfile

serviceFile

private string $serviceFile

serviceFileMtime

private int $serviceFileMtime

__logLevels

private array $__logLevels

__strPad

private int $__strPad

__logFile

private string $__logFile

__log

private mixed $__log

__localLogLevel

private int $__localLogLevel = 'W_INFO'

__remote

private bool $__remote

Methods

__construct

public __construct(Application $application, Protocol $protocol, bool $remote = false): void

Parameters

Parameter	Type	Description
`$application`	`Application`
`$protocol`	`Protocol`
`$remote`	`bool`

__destruct

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): bool

Parameters

Parameter	Type	Description
`$e`	`\Throwable`

__processCommand

protected __processCommand(string $command, mixed $payload): bool

Parameters

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

__processSchedule

private __processSchedule(): void

__sendHeartbeat

protected __sendHeartbeat(): void

__stateString

private __stateString(?int $state): string

Parameters

Parameter	Type	Description
`$state`	`int`

__rotateLogFiles

private __rotateLogFiles(int $logfiles = 0): void

Parameters

Parameter	Type	Description
`$logfiles`	`int`

log

public log(int $level, mixed $message, ?string $name): bool

Parameters

Parameter	Type	Description
`$level`	`int`
`$message`	`mixed`
`$name`	`string`

debug

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

Parameters

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

main

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

Parameters

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

run

public run(): void

shutdown

public shutdown(): bool

stop

public stop(): void

restart

public restart(): bool

state

public state(): int

delay

public delay(int $seconds, string $callback, array $arguments = []): string

Parameters

Parameter	Type	Description
`$seconds`	`int`
`$callback`	`string`
`$arguments`	`array`

interval

public interval(int $seconds, string $callback, array $params = [], ?string $tag, bool $overwrite = false): string

Parameters

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

schedule

public schedule(DateTime $date, string $callback, array $params = [], ?string $tag, bool $overwrite = false): string

Parameters

Parameter	Type	Description
`$date`	`DateTime`
`$callback`	`string`
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

cron

public cron(string $format, string $callback, ?array $arguments): string

Parameters

Parameter	Type	Description
`$format`	`string`
`$callback`	`string`
`$arguments`	`array`

cancel

public cancel(string $id): bool

Parameters

Parameter	Type	Description
`$id`	`string`

signal

public signal(string $eventID, mixed $data): bool

Parameters

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

send

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

Parameters

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

recv

public recv(mixed $payload, int $tv_sec = 3, int $tv_usec = 0): string

Parameters

Parameter	Type	Description
`$payload`	`mixed`
`$tv_sec`	`int`
`$tv_usec`	`int`

connect

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

Parameters

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

sleep

protected sleep(int $timeout = 0): bool

Parameters

Parameter	Type	Description
`$timeout`	`int`

invokeMethod

private invokeMethod(string $method, ?array $arguments): mixed

Parameters

Parameter	Type	Description
`$method`	`string`
`$arguments`	`array`

start

private start(): bool

Generated by Hazaar API Doc Generator