include/SugarQueue/SugarCronJobs.php
Show:
inherited
inherited
Classes
\SugarCronJobs
Package: SugarCRM
CRON driver for job queue
- Children
- \SugarCronRemoteJobs
- \SugarCronParallelJobs
- Api
Properties
bool
$disable_schedulers= 'false'
This allows to disable schedulers cycle, e.g. for testing
Default value
falseDetails- Type
- bool
string
$lockfile= ''
Lock file to ensure the jobs aren't run too fast
Details
- Type
- string
int
$max_jobs= '10'
Max number of jobs per cron run
Default value
10Details- Type
- int
int
$max_runtime= '60'
Max time per cron run
Default value
60Details- Type
- int
int
$min_interval= '30'
Min time between cron runs
Default value
30Details- Type
- int
bool
$runOk= 'true'
Is current queue run OK?
Default value
trueDetails- Type
- bool
bool
$verbose= 'false'
Should the driver print reports to stdout?
Default value
falseDetails- Type
- bool
Methods
__construct(
)
:
voidexecuteJob(
\SchedulersJob $job
)
:
voidExecute given job
Parameters
| Name | Type | Description |
|---|---|---|
| $job | \SchedulersJob |
getMyId(
)
:
stringReturn ID for this client
Returns
| Type | Description |
|---|---|
| string |
jobFailed(
\SchedulersJob $job
=
null
)
:
voidWhat to do if one of the jobs failed
Parameters
| Name | Type | Description |
|---|---|---|
| $job | \SchedulersJob |
markLastRun(
)
:
voidRemember last time it was run
runCycle(
)
:
voidRun CRON cycle: - cleanup - schedule new jobs - execute pending jobs
runOk(
)
:
voidCheck if the queue run was fine
throttle(
)
:
boolCheck if we aren't running jobs too frequently
Returns
| Type | Description |
|---|---|
| bool | OK to run? |
unexpectedExit(
)
:
voidShutdown handler to be called if something breaks in the middle of the job