include/SugarQueue/SugarJobQueue.php
Show:
inherited
inherited
Classes
\SugarJobQueue
Package: SugarCRM
Job queue driver
- Api
Properties
int
$jobTries= '5'
Max number of failures for job
Default value
5Details- Type
- int
string
$job_queue_table= ''
Table in the DB that stores jobs
Details
- Type
- string
int
$timeout= '86400'
Job running timeout - longer than that, job is failed by force
Default value
86400Details- Type
- int
Methods
__construct(
)
:
voidcleanQueue(
)
:
voidNuke all jobs from the queue
cleanup(
)
:
boolRemove old jobs that still are marked as running
Returns
| Type | Description |
|---|---|
| bool | true if no failed job discovered, false if some job were failed |
deleteJob(
string $jobId
)
:
voidDelete a job
Parameters
| Name | Type | Description |
|---|---|---|
| $jobId | string |
getJob(
string $jobId
)
:
\SugarJobGet Job object by ID
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $jobId | string |
| Type | Description |
|---|---|
| \SugarJob |
nextJob(
string $clientID
)
:
\SugarJobFetch the next job in the queue and mark it running
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $clientID | string | ID of the client requesting the job |
| Type | Description |
|---|---|
| \SugarJob |
postponeJob(
string $jobId, string $message
=
null, string $delay
=
null
)
:
boolRerun this job again
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $jobId | string | |
| $message | string | |
| $delay | string | how long to delay (default is job's delay) |
| Type | Description |
|---|---|
| bool |
resolveJob(
string $jobId, string $resolution, string $message
=
null
)
:
boolResolve job as success or failure
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $jobId | string | |
| $resolution | string | One of JOB_ constants that define job status |
| $message | string |
| Type | Description |
|---|---|
| bool |
runSchedulers(
)
:
voidRun schedulers to instantiate scheduled jobs
submitJob(
\SugarJob $job
)
:
voidSubmit a new job to the queue
Parameters
| Name | Type | Description |
|---|---|---|
| $job | \SugarJob |