Properties

$id

$id : string

任务唯一ID

Type

string

$type

$type : string

任务类型

\Imi\Cron\Consts\CronTaskType 类常量

Type

string

$task

$task : string

任务执行回调,可以是callable类型,也可以是 task、process 名

Type

string

$cronRules

$cronRules : array<mixed,\Imi\Cron\CronRule>

定时配置

Type

array<mixed,\Imi\Cron\CronRule>

$data

$data : mixed

数据

Type

mixed

$unique

$unique : string

定时任务唯一性设置 当前实例唯一: current 所有实例唯一: all 不唯一: null

Type

string

$redisPool

$redisPool : string

用于锁的 `Redis` 连接池名

Type

string

$lockWaitTimeout

$lockWaitTimeout : float

获取锁超时时间,单位:秒

Type

float

$maxExecutionTime

$maxExecutionTime : float

最大运行执行时间,单位:秒。该值与分布式锁超时时间共享

Type

float

$lastRunTime

$lastRunTime : integer

获取上一次运行时间

Type

integer

$force

$force : boolean

每次启动服务强制执行

Type

boolean

Methods

__construct()

__construct(string  $id, string  $type, callable|string  $task, array  $cronRules, mixed  $data, float  $maxExecutionTime = 3, string|null  $unique = null, string|null  $redisPool = null, float  $lockWaitTimeout = 3, boolean  $force = false) 

构造方法

Parameters

string $id
string $type
callable|string $task
array $cronRules
mixed $data
float $maxExecutionTime
string|null $unique
string|null $redisPool
float $lockWaitTimeout
boolean $force

getId()

getId() : string

Get 任务唯一ID

Returns

string

getType()

getType() : string

Get \Imi\Cron\Consts\CronTaskType 类常量

Returns

string

getTask()

getTask() : string

Get 任务执行回调,可以是callable类型,也可以是 task、process 名

Returns

string

getCronRules()

getCronRules() : array<mixed,\Imi\Cron\CronRule>

Get 定时配置

Returns

array<mixed,\Imi\Cron\CronRule>

getData()

getData() : mixed

Get 数据

Returns

mixed

getUnique()

getUnique() : boolean

Get 在当前服务实例中唯一,只能同时执行一个

Returns

boolean

getRedisPool()

getRedisPool() : string

Get 用于锁的 `Redis` 连接池名

Returns

string

getLockWaitTimeout()

getLockWaitTimeout() : float

Get 获取锁超时时间,单位:秒

Returns

float

getLastRunTime()

getLastRunTime() : void

获取上一次执行时间

返回秒级时间戳

getMaxExecutionTime()

getMaxExecutionTime() : float

Get 最大运行执行时间,单位:秒。该值与分布式锁超时时间共享

Returns

float

updateLastRunTime()

updateLastRunTime(integer  $time) : void

更新最后执行时间

Parameters

integer $time

getForce()

getForce() : boolean

Get 每次启动服务强制执行

Returns

boolean

parseCronRule()

parseCronRule(array  $cronRules) : array<mixed,\Imi\Cron\CronRule>

处理定时规则

Parameters

array $cronRules

Returns

array<mixed,\Imi\Cron\CronRule>