PHP Класс Cronario\Queue

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$producer Producer

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
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

Описание методов

buildPayload() защищенный статический Метод

protected static buildPayload ( $queueName, $jobState ) : string
$queueName string
$jobState string
Результат string

buryJob() публичный Метод

public buryJob ( $id ) : boolean
$id
Результат boolean

clean() публичный Метод

public clean ( )

deleteJob() публичный Метод

public deleteJob ( $id ) : boolean
$id
Результат boolean

existsJob() публичный Метод

public existsJob ( $id ) : boolean
$id
Результат boolean

getAppId() публичный Метод

public getAppId ( ) : string
Результат string

getJobCount() публичный Метод

public getJobCount ( $queue, $state ) : integer | string
$queue
$state
Результат integer | string

getJobReserved() публичный Метод

public getJobReserved ( ) : array
Результат array

getKey() защищенный Метод

protected getKey ( string $queue, string $state = self::STATE_READY ) : string
$queue string
$state string
Результат string

getKeyBuried() защищенный Метод

protected getKeyBuried ( $queue ) : string
$queue
Результат string

getKeyDelayed() защищенный Метод

protected getKeyDelayed ( $queue ) : string
$queue
Результат string

getKeyReady() защищенный Метод

protected getKeyReady ( $queue ) : string
$queue
Результат string

getKeyReserved() защищенный Метод

protected getKeyReserved ( $queue ) : string
$queue
Результат string

getPayload() защищенный Метод

protected getPayload ( $id ) : mixed
$id
Результат mixed

getProducer() публичный Метод

public getProducer ( ) : Producer
Результат Producer

getQueueInfo() публичный Метод

public getQueueInfo ( $queueName ) : array
$queueName
Результат array

getQueueNameFromKey() защищенный Метод

protected getQueueNameFromKey ( string $key ) : string
$key string
Результат string

getQueueNames() публичный Метод

public getQueueNames ( ) : array
Результат array

getRedis() публичный Метод

public getRedis ( ) : Client
Результат Predis\Client

getRedisJobNamespace() защищенный Метод

protected getRedisJobNamespace ( ) : string
Результат string

getRedisQueueNamespace() защищенный Метод

protected getRedisQueueNamespace ( ) : string
Результат string

getRedisQueueStopNamespace() защищенный Метод

protected getRedisQueueStopNamespace ( ) : string
Результат string

getStats() публичный Метод

Keys that can be expected to be returned are the following:
public getStats ( ) : array
Результат array

getTime() защищенный Метод

protected getTime ( ) : integer
Результат integer

isStop() публичный Метод

public isStop ( $queueName ) : boolean
$queueName
Результат boolean

kickJob() публичный Метод

public kickJob ( $id ) : boolean
$id
Результат boolean

migrate() публичный Метод

public migrate ( null $queue = null ) : boolean
$queue null
Результат boolean

parsePayload() защищенный статический Метод

protected static parsePayload ( $rawPayload ) : mixed
$rawPayload
Результат mixed

putJob() публичный Метод

public putJob ( $queue, $id, integer $delay, string $priority = self::PRIORITY_LOW ) : boolean
$queue
$id
$delay integer
$priority string
Результат boolean

releaseJob() публичный Метод

public releaseJob ( $id, integer $delay ) : boolean
$id
$delay integer
Результат boolean

reserveJob() публичный Метод

public reserveJob ( $queue, null $timeout = null ) : null | string
$queue
$timeout null
Результат null | string

setProducer() публичный Метод

public setProducer ( Producer $producer )
$producer Producer

start() публичный Метод

public start ( $queueName ) : boolean
$queueName
Результат boolean

stop() публичный Метод

public stop ( $queueName ) : boolean
$queueName
Результат boolean

Описание свойств

$producer защищенное свойство

protected Producer,cronario $producer
Результат Producer