1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. SystemWorker
  7. \
  8. Worker
  9. \
  10. BaseWorker

BaseWorker

abstract class BaseWorker

Properties

SystemWorkerController $mod

Methods

__construct(SystemWorkerController $mod)

No description

BaseWorker
applyXELOSConfigurationParameters()

No description

Base
getApiClient()

No description

string|null
getApiHost()

No description

array|null
getCallbackCheckResult(string $callbackUri, string|null $bearerToken = null)

Sends a request containing the callback URI in order to test, whether the callback can be called from the worker back to XELOS.

static string
getIconClass()

No description

int|null
getLocalPackageMaxLength()

Fetches the package max length from the environment variables (most likely the Docker environment) and calculates the length according to the unit.

string
getName()

No description

string
getWorkerID()

No description

int
getWorkerPackageMaxLength()

Fetches the package_max_length setting from the video worker instance used for comparison with the local setting.

array
getWorkerRequestLog()

Returns the logs of worker requests.

array
getWorkerStats()

Retrieve current worker stats Currently this is primarily based upon Openswoole (see https://openswoole.com/docs/modules/swoole-server-stats )

bool
isWorkerAvailable()

Can we connect to the worker service / container?

Details

at line 15
__construct(SystemWorkerController $mod)

No description

Parameters

SystemWorkerController $mod

at line 81
BaseWorker applyXELOSConfigurationParameters()

No description

Return Value

BaseWorker

at line 78
abstract Base getApiClient()

No description

Return Value

Base

at line 27
string|null getApiHost()

No description

Return Value

string|null

at line 143
array|null getCallbackCheckResult(string $callbackUri, string|null $bearerToken = null)

Sends a request containing the callback URI in order to test, whether the callback can be called from the worker back to XELOS.

Parameters

string $callbackUri
string|null $bearerToken

Return Value

array|null

at line 74
static string getIconClass()

No description

Return Value

string

at line 128
protected int|null getLocalPackageMaxLength()

Fetches the package max length from the environment variables (most likely the Docker environment) and calculates the length according to the unit.

Return Value

int|null

at line 70
string getName()

No description

Return Value

string

at line 19
string getWorkerID()

No description

Return Value

string

at line 115
protected int getWorkerPackageMaxLength()

Fetches the package_max_length setting from the video worker instance used for comparison with the local setting.

Return Value

int

0 If the variable is not set. Otherwise the variable's value.

at line 157
array getWorkerRequestLog()

Returns the logs of worker requests.

Return Value

array

at line 57
array getWorkerStats()

Retrieve current worker stats Currently this is primarily based upon Openswoole (see https://openswoole.com/docs/modules/swoole-server-stats )

Return Value

array

[ 'up' => 1|0, 'version' => 'OpenSwoole-22.0.0', 'workers_total' => 12, 'workers_idle' => 11, 'start_time' => 1700464155, 'start_seconds' => 123, 'connections_accepted' => 100, 'connections_active' => 1, 'connections_closed' => 99 ]

at line 36
bool isWorkerAvailable()

Can we connect to the worker service / container?

Return Value

bool