PHP Class MGDigital\BusQue\Redis\RedisDriver

Inheritance: implements MGDigital\BusQue\QueueDriverInterface, implements MGDigital\BusQue\SchedulerDriverInterface
Show file Open project: mgdigital/busque

Public Methods

Method Description
__construct ( MGDigital\BusQue\Redis\RedisAdapterInterface $adapter, string $namespace = '' )
awaitCommand ( string $queueName, integer $time = null ) : ReceivedCommand
cancelScheduledCommand ( string $queueName, string $id )
clearSchedule ( array $queueNames = null, DateTimeInterface $start = null, DateTimeInterface $end = null )
completeCommand ( string $queueName, string $id )
deleteQueue ( string $queueName )
getConsumingIds ( string $queueName ) : array
getQueueNames ( ) : array
getQueuedCount ( string $queueName ) : integer
getQueuedIds ( string $queueName, integer $offset, integer $limit = 10 ) : array
getScheduledTime ( string $queueName, string $id ) : DateTimeInterface | null
isIdConsuming ( string $queueName, string $id ) : boolean
isIdQueued ( string $queueName, string $id ) : boolean
purgeCommand ( string $queueName, string $id )
purgeNamespace ( )
putQueue ( string $queueName )
queueCommand ( string $queueName, string $commandId, string $serialized )
readCommand ( string $queueName, string $id ) : string
receiveDueCommands ( DateTimeInterface $now, integer $limit = SchedulerWorker::DEFAULT_THROTTLE, DateTimeInterface $startTime = null ) : array
scheduleCommand ( string $queueName, string $id, string $serialized, DateTimeInterface $dateTime )

Private Methods

Method Description
evalScript ( string $script, array $args )

Method Details

__construct() public method

public __construct ( MGDigital\BusQue\Redis\RedisAdapterInterface $adapter, string $namespace = '' )
$adapter MGDigital\BusQue\Redis\RedisAdapterInterface
$namespace string

awaitCommand() public method

public awaitCommand ( string $queueName, integer $time = null ) : ReceivedCommand
$queueName string
$time integer
return MGDigital\BusQue\ReceivedCommand

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

completeCommand() public method

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

deleteQueue() public method

public deleteQueue ( string $queueName )
$queueName string

getConsumingIds() public method

public getConsumingIds ( string $queueName ) : array
$queueName string
return array

getQueueNames() public method

public getQueueNames ( ) : array
return array

getQueuedCount() public method

public getQueuedCount ( string $queueName ) : integer
$queueName string
return integer

getQueuedIds() public method

public getQueuedIds ( string $queueName, integer $offset, integer $limit = 10 ) : array
$queueName string
$offset integer
$limit integer
return array

getScheduledTime() public method

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

isIdConsuming() public method

public isIdConsuming ( string $queueName, string $id ) : boolean
$queueName string
$id string
return boolean

isIdQueued() public method

public isIdQueued ( string $queueName, string $id ) : boolean
$queueName string
$id string
return boolean

purgeCommand() public method

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

purgeNamespace() public method

public purgeNamespace ( )

putQueue() public method

public putQueue ( string $queueName )
$queueName string

queueCommand() public method

public queueCommand ( string $queueName, string $commandId, string $serialized )
$queueName string
$commandId string
$serialized string

readCommand() public method

public readCommand ( string $queueName, string $id ) : string
$queueName string
$id string
return string

receiveDueCommands() public method

public receiveDueCommands ( DateTimeInterface $now, integer $limit = SchedulerWorker::DEFAULT_THROTTLE, DateTimeInterface $startTime = null ) : array
$now DateTimeInterface
$limit integer
$startTime DateTimeInterface
return array

scheduleCommand() public method

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