Process

About 3 min

Process

Properties

start

public int $start

state

public int $state = 'HAZAAR_SERVICE_NONE'

conn

protected Connection $conn

id

public string $id

application

protected Application $application

protocol

protected Protocol $protocol

subscriptions

protected array $subscriptions

options

private array $options = array (
  'serviceName' => 
  array (
    0 => 'n',
    1 => 'name',
    2 => 'serviceName',
    3 => '"\\tStart a service directly from the command line."',
  ),
  'daemon' => 
  array (
    0 => 'd',
    1 => 'daemon',
    2 => NULL,
    3 => '"\\t\\t\\t\\tStart in daemon mode and wait for a startup packet."',
  ),
  'help' => 
  array (
    0 => NULL,
    1 => 'help',
    2 => NULL,
    3 => '"\\t\\t\\t\\tPrint this message and exit."',
  ),
)

opt

private array $opt

Methods

__construct

public __construct(Application $application, Protocol $protocol, ?string $guid): void

Parameters

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

__destruct

public __destruct(): void

__processCommand

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

Parameters

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

__kv_send_recv

private __kv_send_recv(string $command, array $data): string

Parameters

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

construct

Constructor placeholder for child classes.

public construct(Application $application): void

Parameters

Parameter	Type	Description
`$application`	`Application`

init

Initialisation placeholder for child classes.

public init(): bool

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`

ping

public ping(bool $waitPong = false): string

Parameters

Parameter	Type	Description
`$waitPong`	`bool`

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

Parameters

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

unsubscribe

public unsubscribe(string $event): bool

Parameters

Parameter	Type	Description
`$event`	`string`

trigger

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

Parameters

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

log

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

Parameters

Parameter	Type	Description
`$level`	`int`
`$message`	`string`
`$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

runDelay

public runDelay(int $delay, callable $callable, array $params = [], ?string $tag, bool $overwrite = false): string

Parameters

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

interval

public interval(int $seconds, string $callable, array $params = [], ?string $tag, bool $overwrite = false): 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 = false): string

Parameters

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

cancel

public cancel(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): string

Parameters

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

del

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

Parameters

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

clear

public clear(?string $namespace): string

Parameters

Parameter	Type	Description
`$namespace`	`string`

public (?string $namespace): string

Parameters

Parameter	Type	Description
`$namespace`	`string`

pull

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

Parameters

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

push

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

Parameters

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

pop

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

Parameters

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

shift

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

Parameters

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

unshift

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

Parameters

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

incr

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

Parameters

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

decr

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

Parameters

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

keys

public keys(?string $namespace): string

Parameters

Parameter	Type	Description
`$namespace`	`string`

vals

public vals(?string $namespace): string

Parameters

Parameter	Type	Description
`$namespace`	`string`

count

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

Parameters

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

runner

public runner(Application $application, ?array $argv): int

Parameters

Parameter	Type	Description
`$application`	`Application`
`$argv`	`array`

getServiceClass

public getServiceClass(string $serviceName, Application $application, Protocol $protocol, bool $remote = false): Service

Parameters

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

setErrorHandler

protected setErrorHandler(string $methodName): void

Parameters

Parameter	Type	Description
`$methodName`	`string`

setExceptionHandler

protected setExceptionHandler(string $methodName): void

Parameters

Parameter	Type	Description
`$methodName`	`string`

connect

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

Parameters

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

disconnect

protected disconnect(): void

connected

protected connected(): bool

makeCallable

protected makeCallable(\Closure $callable): void

Parameters

Parameter	Type	Description
`$callable`	`\Closure`

sendExec

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

Parameters

Parameter	Type	Description
`$command`	`string`
`$data`	`mixed`
`$callable`	`callable`
`$params`	`array`
`$tag`	`string`
`$overwrite`	`bool`

getopt

private getopt(int $): void

Parameters

Parameter	Type	Description
`$`	`int`

showHelp

private showHelp(): int

Generated by Hazaar API Doc Generator