Abstract Class zhuravljov\yii\queue\BaseDriver

All Classes | Properties | Methods

Inheritance	zhuravljov\yii\queue\BaseDriver » yii\base\Object
Subclasses	zhuravljov\yii\queue\db\Driver, zhuravljov\yii\queue\sync\Driver
Source Code	https://github.com/yiisoft/yii2-queue/blob/master/src/BaseDriver.php

Queue driver interface

Public Properties

Property	Type	Description	Defined By
$queue	zhuravljov\yii\queue\Queue		zhuravljov\yii\queue\BaseDriver

Method	Description	Defined By
__construct()		zhuravljov\yii\queue\BaseDriver
pop()	Pops message and job from the storage.	zhuravljov\yii\queue\BaseDriver
purge()	Purges the storage.	zhuravljov\yii\queue\BaseDriver
push()	Pushes job to the storage.	zhuravljov\yii\queue\BaseDriver
release()	Releases the message.	zhuravljov\yii\queue\BaseDriver

Method	Description	Defined By
getQueue()		zhuravljov\yii\queue\BaseDriver

$queue public property

__construct() public method

public __construct ( zhuravljov\yii\queue\Queue $queue, mixed $config = [] )
$queue	zhuravljov\yii\queue\Queue
$config	mixed

                public function __construct(Queue $queue, $config = [])
{
    $this->_queue = $queue;
    parent::__construct($config);
}

getQueue() protected method

protected zhuravljov\yii\queue\Queue getQueue ( )

                protected function getQueue()
{
    return $this->_queue;
}

pop() public abstract method

Pops message and job from the storage.

public abstract boolean pop ( mixed &$message, zhuravljov\yii\queue\Job &$job )
$message	mixed
$job	zhuravljov\yii\queue\Job

                abstract public function pop(&$message, &$job);

purge() public abstract method

Purges the storage.

public abstract mixed purge ( )

                abstract public function purge();

push() public abstract method

Pushes job to the storage.

public abstract mixed push ( zhuravljov\yii\queue\Job $job )
$job	zhuravljov\yii\queue\Job
return	mixed	$message

                abstract public function push($job);

release() public abstract method

Releases the message.

public abstract mixed release ( mixed $message )
$message	mixed

                abstract public function release($message);