PHP Interface MGDigital\BusQue\SchedulerDriverInterface

Show file Open project: mgdigital/busque

Public Methods

Method	Description
cancelScheduledCommand ( string $queueName, string $id )
clearSchedule ( array $queueNames = null, DateTimeInterface $start = null, DateTimeInterface $end = null )
getScheduledTime ( string $queueName, string $id ) : DateTimeInterface \| null
receiveDueCommands ( DateTimeInterface $now, integer $limit = SchedulerWorker::DEFAULT_THROTTLE, DateTimeInterface $startTime = null ) : array
scheduleCommand ( string $queueName, string $id, string $serialized, DateTimeInterface $dateTime )

Method Details

cancelScheduledCommand() public method

public cancelScheduledCommand ( string $queueName, string $id )
$queueName	string
$id	string

clearSchedule() public method

public clearSchedule ( array $queueNames = null, DateTimeInterface $start = null, DateTimeInterface $end = null )
$queueNames	array
$start	DateTimeInterface
$end	DateTimeInterface

getScheduledTime() public method

public getScheduledTime ( string $queueName, string $id ) : DateTimeInterface \| null
$queueName	string
$id	string
return	DateTimeInterface \| null

receiveDueCommands() public method

public receiveDueCommands ( DateTimeInterface $now, integer $limit = SchedulerWorker::DEFAULT_THROTTLE, DateTimeInterface $startTime = null ) : array
$now	DateTimeInterface
$limit	integer	The maximum number of scheduled commands to return.
$startTime	DateTimeInterface	Return due commands since $startTime or the beginning of time.
return	array

scheduleCommand() public method

public scheduleCommand ( string $queueName, string $id, string $serialized, DateTimeInterface $dateTime )
$queueName	string
$id	string
$serialized	string
$dateTime	DateTimeInterface