KMP PHP API Reference

Config
in package

Table of Contents

Methods

cleanuptimeout()  : int
Minimum number of seconds before a cleanup run will remove a completed task (set to 0 to disable)
defaultworkerretries()  : int
defaultworkertimeout()  : int
Timeout in seconds, after which the Task is reassigned to a new worker if not finished successfully.
gcprob()  : int
ignoredTasks()  : array<string|int, string>
maxworkers()  : int
sleeptime()  : int
taskConfig()  : array<string, array<string, mixed>>
taskName()  : string
workermaxruntime()  : int
Seconds of running time after which the worker will terminate (0 = unlimited)

Methods

cleanuptimeout()

Minimum number of seconds before a cleanup run will remove a completed task (set to 0 to disable)

public static cleanuptimeout() : int
Return values
int

defaultworkerretries()

public static defaultworkerretries() : int
Return values
int

defaultworkertimeout()

Timeout in seconds, after which the Task is reassigned to a new worker if not finished successfully.

public static defaultworkertimeout() : int

This should be high enough that it cannot still be running on a zombie worker (>> 2x) and cannot be zero.

Return values
int

gcprob()

public static gcprob() : int
Return values
int

ignoredTasks()

public static ignoredTasks() : array<string|int, string>
Return values
array<string|int, string>

maxworkers()

public static maxworkers() : int
Return values
int

sleeptime()

public static sleeptime() : int
Return values
int

taskConfig()

public static taskConfig(array<string|int, string> $tasks) : array<string, array<string, mixed>>
Parameters
$tasks : array<string|int, string>
Tags
throws
RuntimeException
Return values
array<string, array<string, mixed>>

taskName()

public static taskName(string $class) : string
Parameters
$class : string
Tags
phpstan-param

class-string<\Queue\Queue\Task>|string $class

Return values
string

workermaxruntime()

Seconds of running time after which the worker will terminate (0 = unlimited)

public static workermaxruntime() : int
Return values
int

        
On this page

Search results