Class yii\queue\gearman\Queue

Inheritanceyii\queue\gearman\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component » yii\base\BaseObject
Implementsyii\base\BootstrapInterface, yii\base\Configurable
Source Code https://github.com/yiisoft/yii2-queue/blob/master/gearman/Queue.php

Gearman Queue.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bootstrap() Bootstrap method to be called during application bootstrap stage. yii\queue\cli\Queue
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
delay() Sets delay for later execute. yii\queue\Queue
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
execute() yii\queue\cli\Queue
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getWorkerPid() Gets process ID of a worker. yii\queue\cli\Queue
handleError() yii\queue\Queue
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\BaseObject
isDone() yii\queue\Queue
isReserved() yii\queue\Queue
isWaiting() yii\queue\Queue
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
priority() Sets job priority. yii\queue\Queue
push() Pushes job into queue. yii\queue\Queue
run() Listens queue and runs each job. yii\queue\gearman\Queue
status() yii\queue\gearman\Queue
trigger() Triggers an event. yii\base\Component
ttr() Sets TTR for job execute. yii\queue\Queue
unserializeMessage() Unserializes. yii\queue\Queue

Events

Hide inherited events

EventTypeDescriptionDefined 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_LOOP yii\queue\cli\WorkerEvent That is triggered each iteration between requests to queue. (available since version 2.0.3) yii\queue\cli\Queue
EVENT_WORKER_START yii\queue\cli\WorkerEvent That is triggered when the worker is started. (available since version 2.0.2) yii\queue\cli\Queue
EVENT_WORKER_STOP yii\queue\cli\WorkerEvent That is triggered when the worker is stopped. (available since version 2.0.2) yii\queue\cli\Queue

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
STATUS_DONE 3 yii\queue\Queue
STATUS_RESERVED 2 yii\queue\Queue
STATUS_WAITING 1 yii\queue\Queue

Property Details

$channel public property
public $channel 'queue'
$commandClass public property

Command class name

public string $commandClass = \yii\queue\gearman\Command::class
$host public property
public $host 'localhost'
$port public property
public $port 4730

Method Details

getClient() protected method

protected \GearmanClient getClient ( )
pushMessage() protected method

protected string pushMessage ( $message, $ttr, $delay, $priority )
$message string
$ttr integer

Time to reserve in seconds

$delay integer
$priority mixed
return string

Id of a job message

run() public method (available since version 2.0.2)

Listens queue and runs each job.

public null|integer run ( $repeat )
$repeat boolean

Whether to continue listening when queue is empty.

return null|integer

Exit code.

status() public method

public integer status ( $id )
$id string

Of a job message

return integer

Status code