Class yii\queue\gearman\Queue

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\queue\gearman\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component
Implements	yii\base\BootstrapInterface

Gearman Queue

Public Properties

Property	Type	Description	Defined By
$attempts	integer	Default attempt count	yii\queue\Queue
$channel			yii\queue\gearman\Queue
$commandClass	string	Command class name	yii\queue\gearman\Queue
$commandOptions	array	Of additional options of command	yii\queue\cli\Queue
$host			yii\queue\gearman\Queue
$loopConfig	array\|string		yii\queue\cli\Queue
$messageHandler	callable\|null		yii\queue\cli\Queue
$port			yii\queue\gearman\Queue
$serializer	yii\queue\serializers\SerializerInterface\|array		yii\queue\Queue
$strictJobType	boolean	Whether to enable strict job type control.	yii\queue\Queue
$ttr	integer	Default time to reserve a job	yii\queue\Queue

Method	Description	Defined By
bootstrap()		yii\queue\cli\Queue
delay()	Sets delay for later execute	yii\queue\Queue
execute()		yii\queue\cli\Queue
getWorkerPid()	Gets process ID of a worker.	yii\queue\cli\Queue
handleError()		yii\queue\Queue
init()		yii\queue\Queue
isDone()		yii\queue\Queue
isReserved()		yii\queue\Queue
isWaiting()		yii\queue\Queue
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
ttr()	Sets TTR for job execute	yii\queue\Queue

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

Constant	Value	Defined By
STATUS_DONE	3	yii\queue\Queue
STATUS_RESERVED	2	yii\queue\Queue
STATUS_WAITING	1	yii\queue\Queue

$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

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