Class yii\queue\amqp_interop\Queue

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\queue\amqp_interop\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component
Implements	yii\base\BootstrapInterface
Available since version	2.0.2

Amqp Queue

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$attempts	integer	Default attempt count	yii\queue\Queue
$commandClass	string	Command class name	yii\queue\amqp_interop\Queue
$commandOptions	array	Of additional options of command	yii\queue\cli\Queue
$connectionTimeout	float\|null		yii\queue\amqp_interop\Queue
$driver	string		yii\queue\amqp_interop\Queue
$dsn	string		yii\queue\amqp_interop\Queue
$exchangeName	string		yii\queue\amqp_interop\Queue
$heartbeat	float\|null		yii\queue\amqp_interop\Queue
$host	string\|null		yii\queue\amqp_interop\Queue
$lazy	boolean\|null		yii\queue\amqp_interop\Queue
$loopConfig	array\|string		yii\queue\cli\Queue
$maxPriority	integer		yii\queue\amqp_interop\Queue
$messageHandler	callable\|null		yii\queue\cli\Queue
$password	string\|null		yii\queue\amqp_interop\Queue
$persisted	boolean\|null		yii\queue\amqp_interop\Queue
$port	string\|null		yii\queue\amqp_interop\Queue
$qosGlobal	boolean\|null		yii\queue\amqp_interop\Queue
$qosPrefetchCount	integer\|null		yii\queue\amqp_interop\Queue
$qosPrefetchSize	integer\|null		yii\queue\amqp_interop\Queue
$queueName	string		yii\queue\amqp_interop\Queue
$readTimeout	float\|null		yii\queue\amqp_interop\Queue
$serializer	yii\queue\serializers\SerializerInterface\|array		yii\queue\Queue
$sslCacert	string\|null		yii\queue\amqp_interop\Queue
$sslCert	string\|null		yii\queue\amqp_interop\Queue
$sslKey	string\|null		yii\queue\amqp_interop\Queue
$sslOn	boolean\|null		yii\queue\amqp_interop\Queue
$sslVerify	boolean\|null		yii\queue\amqp_interop\Queue
$strictJobType	boolean	Whether to enable strict job type control.	yii\queue\Queue
$ttr	integer	Default time to reserve a job	yii\queue\Queue
$user	string\|null		yii\queue\amqp_interop\Queue
$vhost	string\|null		yii\queue\amqp_interop\Queue
$writeTimeout	float\|null		yii\queue\amqp_interop\Queue

Protected Properties

Hide inherited properties

Property	Type	Defined By
$context	\Interop\Amqp\AmqpContext	yii\queue\amqp_interop\Queue
$setupBrokerDone	boolean	yii\queue\amqp_interop\Queue
$supportedDrivers	string[]	yii\queue\amqp_interop\Queue

Public Methods

Hide inherited methods

Method	Description	Defined By
bootstrap()		yii\queue\cli\Queue
delay()	Sets delay for later execute	yii\queue\Queue
execute()		yii\queue\cli\Queue
getContext()		yii\queue\amqp_interop\Queue
getWorkerPid()	Gets process ID of a worker.	yii\queue\cli\Queue
handleError()		yii\queue\Queue
init()		yii\queue\amqp_interop\Queue
isDone()		yii\queue\Queue
isReserved()		yii\queue\Queue
isWaiting()		yii\queue\Queue
listen()	Listens amqp-queue and runs new jobs.	yii\queue\amqp_interop\Queue
priority()	Sets job priority	yii\queue\Queue
push()	Pushes job into queue	yii\queue\Queue
status()		yii\queue\amqp_interop\Queue
ttr()	Sets TTR for job execute	yii\queue\Queue

Protected Methods

Hide inherited methods

Method	Description	Defined By
close()	Closes connection and channel	yii\queue\amqp_interop\Queue
getCommandId()		yii\queue\cli\Queue
handleMessage()		yii\queue\cli\Queue
open()	Opens connection and channel	yii\queue\amqp_interop\Queue
pushMessage()		yii\queue\amqp_interop\Queue
redeliver()		yii\queue\amqp_interop\Queue
runWorker()	Runs worker.	yii\queue\cli\Queue
setupBroker()		yii\queue\amqp_interop\Queue

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ERROR	yii\queue\ExecEvent		yii\queue\Queue
EVENT_AFTER_EXEC	yii\queue\ExecEvent		yii\queue\Queue
EVENT_AFTER_PUSH	yii\queue\PushEvent		yii\queue\Queue
EVENT_BEFORE_EXEC	yii\queue\ExecEvent		yii\queue\Queue
EVENT_BEFORE_PUSH	yii\queue\PushEvent		yii\queue\Queue
EVENT_WORKER_START	yii\queue\cli\WorkerEvent	(available since version 2.0.2)	yii\queue\cli\Queue
EVENT_WORKER_STOP	yii\queue\cli\WorkerEvent	(available since version 2.0.2)	yii\queue\cli\Queue

Constants

Hide inherited constants

Constant	Value	Defined By
ATTEMPT	'yii-attempt'	yii\queue\amqp_interop\Queue
DELAY	'yii-delay'	yii\queue\amqp_interop\Queue
ENQUEUE_AMQP_BUNNY	'enqueue/amqp-bunny'	yii\queue\amqp_interop\Queue
ENQUEUE_AMQP_EXT	'enqueue/amqp-ext'	yii\queue\amqp_interop\Queue
ENQUEUE_AMQP_LIB	'enqueue/amqp-lib'	yii\queue\amqp_interop\Queue
PRIORITY	'yii-priority'	yii\queue\amqp_interop\Queue
STATUS_DONE	3	yii\queue\Queue
STATUS_RESERVED	2	yii\queue\Queue
STATUS_WAITING	1	yii\queue\Queue
TTR	'yii-ttr'	yii\queue\amqp_interop\Queue

Property Details

$commandClass public property

Command class name

public string $commandClass = \yii\queue\amqp_interop\Command::class

$connectionTimeout public property

public float|null $connectionTimeout = null

$context protected property

protected \Interop\Amqp\AmqpContext $context = null

$driver public property

public string $driver = self::ENQUEUE_AMQP_LIB

$dsn public property

public string $dsn = null

$exchangeName public property

public string $exchangeName = 'exchange'

$heartbeat public property

public float|null $heartbeat = null

$host public property

public string|null $host = null

$lazy public property

public boolean|null $lazy = null

$maxPriority public property

public integer $maxPriority = 10

$password public property

public string|null $password = null

$persisted public property

public boolean|null $persisted = null

$port public property

public string|null $port = null

$qosGlobal public property

public boolean|null $qosGlobal = null

$qosPrefetchCount public property

public integer|null $qosPrefetchCount = null

$qosPrefetchSize public property

public integer|null $qosPrefetchSize = null

$queueName public property

public string $queueName = 'interop_queue'

$readTimeout public property

public float|null $readTimeout = null

$setupBrokerDone protected property

protected boolean $setupBrokerDone = false

$sslCacert public property

public string|null $sslCacert = null

$sslCert public property

public string|null $sslCert = null

$sslKey public property

public string|null $sslKey = null

$sslOn public property

public boolean|null $sslOn = null

$sslVerify public property

public boolean|null $sslVerify = null

$supportedDrivers protected property

protected string[] $supportedDrivers = [self::ENQUEUE_AMQP_LIB, self::ENQUEUE_AMQP_EXT, self::ENQUEUE_AMQP_BUNNY]

$user public property

public string|null $user = null

$vhost public property

public string|null $vhost = null

$writeTimeout public property

public float|null $writeTimeout = null

Method Details

close() protected method

Closes connection and channel

protected void close ( )

getContext() public method

public \Interop\Amqp\AmqpContext getContext ( )

init() public method

public void init ( )

listen() public method

Listens amqp-queue and runs new jobs.

public void listen ( )

open() protected method

Opens connection and channel

protected void open ( )

pushMessage() protected method

protected string pushMessage ( $payload, $ttr, $delay, $priority )
$payload
$ttr	integer	Time to reserve in seconds
$delay	integer
$priority	mixed
return	string	Id of a job message

redeliver() protected method

protected void redeliver ( \Interop\Amqp\AmqpMessage $message )
$message

setupBroker() protected method

protected void setupBroker ( )

status() public method

public integer status ( $id )
$id	string	Of a job message
return	integer	Status code