include/SugarQueue/SugarCronRemoteJobs.php

Show:

inherited

Classes
- \SugarCronRemoteJobs

Table of Contents

\SugarCronRemoteJobs
jump to top

Package: SugarCRM

CRON driver for job queue that ships jobs outside

Parent(s): \SugarCronJobs
Api

Properties

string
                 $client= ''

REST client

Details

Type: string

bool
                 $disable_schedulers= 'false'

inherited

This allows to disable schedulers cycle, e.g. for testing

Inherited from: \SugarCronJobs::$$disable_schedulers

Default valuefalseDetails

Type: bool
Inherited_from: \SugarCronJobs::$$disable_schedulers

\SchedulersJob
                 $job= ''

inherited

Currently running job

Inherited from: \SugarCronJobs::$$job

Details

Type: \SchedulersJob
Inherited_from: \SugarCronJobs::$$job

string
                 $jobserver= ''

URL for remote job server

Details

Type: string

string
                 $lockfile= ''

inherited

Lock file to ensure the jobs aren't run too fast

Inherited from: \SugarCronJobs::$$lockfile

Details

Type: string
Inherited_from: \SugarCronJobs::$$lockfile

int
                 $max_jobs= '10'

inherited

Max number of jobs per cron run

Inherited from: \SugarCronJobs::$$max_jobs

Default value10Details

Type: int
Inherited_from: \SugarCronJobs::$$max_jobs

int
                 $max_runtime= '60'

inherited

Max time per cron run

Inherited from: \SugarCronJobs::$$max_runtime

Default value60Details

Type: int
Inherited_from: \SugarCronJobs::$$max_runtime

int
                 $min_interval= '30'

inherited

Min time between cron runs

Inherited from: \SugarCronJobs::$$min_interval

Default value30Details

Type: int
Inherited_from: \SugarCronJobs::$$min_interval

bool
                 $runOk= 'true'

inherited

Is current queue run OK?

Inherited from: \SugarCronJobs::$$runOk

Default valuetrueDetails

Type: bool
Inherited_from: \SugarCronJobs::$$runOk

string
                 $submitURL= '"submitJob"'

Just in case we'd ever need to override...

Default value"submitJob"Details

Type: string

bool
                 $verbose= 'false'

inherited

Should the driver print reports to stdout?

Inherited from: \SugarCronJobs::$$verbose

Default valuefalseDetails

Type: bool
Inherited_from: \SugarCronJobs::$$verbose

Methods

__construct(
          
          )
        
        :
          void

executeJob(
          \SchedulersJob $job
          )
        
        :
          void

Execute given job

Parameters

Name	Type	Description
$job	\SchedulersJob

getMyId(
          
          )
        
        :
          string

Return ID for this client

Returns

Type	Description
string

jobFailed(
          \SchedulersJob $job
              =
              null
          )
        
        :
          void

inherited

What to do if one of the jobs failed

Inherited from: \SugarCronJobs::jobFailed()

Parameters

Name	Type	Description
$job	\SchedulersJob

markLastRun(
          
          )
        
        :
          void

inherited

Remember last time it was run

Inherited from: \SugarCronJobs::markLastRun()

runCycle(
          
          )
        
        :
          void

inherited

Run CRON cycle: - cleanup - schedule new jobs - execute pending jobs

Inherited from: \SugarCronJobs::runCycle()

inherited

Check if the queue run was fine

Inherited from: \SugarCronJobs::runOk()

setClient(
          \SugarHttpClient $client
          )
        
        :
          void

Set client to talk to SNIP

Parameters

Name	Type	Description
$client	\SugarHttpClient

throttle(
          
          )
        
        :
          bool

inherited

Check if we aren't running jobs too frequently

Inherited from: \SugarCronJobs::throttle()

Returns

Type	Description
bool	OK to run?

unexpectedExit(
          
          )
        
        :
          void

inherited

Shutdown handler to be called if something breaks in the middle of the job

Inherited from: \SugarCronJobs::unexpectedExit()

include/SugarQueue/SugarCronRemoteJobs.php

\SugarCronRemoteJobsjump to top

Properties

Methods

\SugarCronRemoteJobs
jump to top