PHP Interface MGDigital\BusQue\QueueDriverInterface

Show file Open project: mgdigital/busque

Public Methods

Method Description
awaitCommand ( string $queueName, integer $time = null ) : ReceivedCommand
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
isIdConsuming ( string $queueName, string $id ) : boolean
isIdQueued ( string $queueName, string $id ) : boolean
purgeCommand ( string $queueName, string $id )
putQueue ( string $queueName )
queueCommand ( string $queueName, string $id, string $serialized )
readCommand ( string $queueName, string $id ) : string

Method Details

awaitCommand() public method

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

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

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

putQueue() public method

public putQueue ( string $queueName )
$queueName string

queueCommand() public method

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

readCommand() public method

public readCommand ( string $queueName, string $id ) : string
$queueName string
$id string
return string The serialized command