PHP Class Cronario\Queue

Datei anzeigen Open project: cronario/cronario

Protected Properties

Property	Type	Description
$producer	Producer

Public Methods

Method	Description
buryJob ( $id ) : boolean
clean ( )
deleteJob ( $id ) : boolean
existsJob ( $id ) : boolean
getAppId ( ) : string
getJobCount ( $queue, $state ) : integer \| string
getJobReserved ( ) : array
getProducer ( ) : Producer
getQueueInfo ( $queueName ) : array
getQueueNames ( ) : array
getRedis ( ) : Client
getStats ( ) : array	Return statistical information about the server, across all clients.
isStop ( $queueName ) : boolean
kickJob ( $id ) : boolean
migrate ( null $queue = null ) : boolean
putJob ( $queue, $id, integer $delay, string $priority = self::PRIORITY_LOW ) : boolean
releaseJob ( $id, integer $delay ) : boolean
reserveJob ( $queue, null $timeout = null ) : null \| string
setProducer ( Producer $producer )
start ( $queueName ) : boolean
stop ( $queueName ) : boolean

Protected Methods

Method	Description
buildPayload ( $queueName, $jobState ) : string
getKey ( string $queue, string $state = self::STATE_READY ) : string
getKeyBuried ( $queue ) : string
getKeyDelayed ( $queue ) : string
getKeyReady ( $queue ) : string
getKeyReserved ( $queue ) : string
getPayload ( $id ) : mixed
getQueueNameFromKey ( string $key ) : string
getRedisJobNamespace ( ) : string
getRedisQueueNamespace ( ) : string
getRedisQueueStopNamespace ( ) : string
getTime ( ) : integer
parsePayload ( $rawPayload ) : mixed

Method Details

buildPayload() protected static method

protected static buildPayload ( $queueName, $jobState ) : string
$queueName		string
$jobState		string
return	string

buryJob() public method

public buryJob ( $id ) : boolean
$id
return	boolean

clean() public method

public clean ( )

deleteJob() public method

public deleteJob ( $id ) : boolean
$id
return	boolean

existsJob() public method

public existsJob ( $id ) : boolean
$id
return	boolean

getAppId() public method

public getAppId ( ) : string
return	string

getJobCount() public method

public getJobCount ( $queue, $state ) : integer \| string
$queue
$state
return	integer \| string

getJobReserved() public method

public getJobReserved ( ) : array
return	array

getKey() protected method

protected getKey ( string $queue, string $state = self::STATE_READY ) : string
$queue	string
$state	string
return	string

getKeyBuried() protected method

protected getKeyBuried ( $queue ) : string
$queue
return	string

getKeyDelayed() protected method

protected getKeyDelayed ( $queue ) : string
$queue
return	string

getKeyReady() protected method

protected getKeyReady ( $queue ) : string
$queue
return	string

getKeyReserved() protected method

protected getKeyReserved ( $queue ) : string
$queue
return	string

getPayload() protected method

protected getPayload ( $id ) : mixed
$id
return	mixed

getProducer() public method

public getProducer ( ) : Producer
return	Producer

getQueueInfo() public method

public getQueueInfo ( $queueName ) : array
$queueName
return	array

getQueueNameFromKey() protected method

protected getQueueNameFromKey ( string $key ) : string
$key	string
return	string

getQueueNames() public method

public getQueueNames ( ) : array
return	array

getRedis() public method

public getRedis ( ) : Client
return	Predis\Client

getRedisJobNamespace() protected method

protected getRedisJobNamespace ( ) : string
return	string

getRedisQueueNamespace() protected method

protected getRedisQueueNamespace ( ) : string
return	string

getRedisQueueStopNamespace() protected method

protected getRedisQueueStopNamespace ( ) : string
return	string

getStats() public method

Keys that can be expected to be returned are the following:

public getStats ( ) : array
return	array

getTime() protected method

protected getTime ( ) : integer
return	integer

isStop() public method

public isStop ( $queueName ) : boolean
$queueName
return	boolean

kickJob() public method

public kickJob ( $id ) : boolean
$id
return	boolean

migrate() public method

public migrate ( null $queue = null ) : boolean
$queue	null
return	boolean

parsePayload() protected static method

protected static parsePayload ( $rawPayload ) : mixed
$rawPayload
return	mixed

putJob() public method

public putJob ( $queue, $id, integer $delay, string $priority = self::PRIORITY_LOW ) : boolean
$queue
$id
$delay	integer
$priority	string
return	boolean

releaseJob() public method

public releaseJob ( $id, integer $delay ) : boolean
$id
$delay	integer
return	boolean

reserveJob() public method

public reserveJob ( $queue, null $timeout = null ) : null \| string
$queue
$timeout	null
return	null \| string

setProducer() public method

public setProducer ( Producer $producer )
$producer	Producer

start() public method

public start ( $queueName ) : boolean
$queueName
return	boolean

stop() public method

public stop ( $queueName ) : boolean
$queueName
return	boolean

Property Details

$producer protected_oe property

protected Producer,cronario $producer
return	Producer