Class yii\queue\file\Queue

All Classes | Properties | Methods | Events | Constants

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

File Queue

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$attempts	integer	Default attempt count	yii\queue\Queue
$commandClass	string		yii\queue\file\Queue
$commandOptions	array	Of additional options of command	yii\queue\cli\Queue
$dirMode	integer		yii\queue\file\Queue
$fileMode	integer\|null		yii\queue\file\Queue
$indexDeserializer	callable		yii\queue\file\Queue
$indexSerializer	callable		yii\queue\file\Queue
$loopConfig	array\|string		yii\queue\cli\Queue
$messageHandler	callable\|null		yii\queue\cli\Queue
$path	string		yii\queue\file\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

Public Methods

Hide inherited methods

Method	Description	Defined By
bootstrap()		yii\queue\cli\Queue
clear()	Clears the queue	yii\queue\file\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\file\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
remove()	Removes a job by ID	yii\queue\file\Queue
run()	Listens queue and runs each job.	yii\queue\file\Queue
status()		yii\queue\file\Queue
ttr()	Sets TTR for job execute	yii\queue\Queue

Protected Methods

Hide inherited methods

Method	Description	Defined By
delete()	Deletes reserved message	yii\queue\file\Queue
getCommandId()		yii\queue\cli\Queue
handleMessage()		yii\queue\cli\Queue
pushMessage()		yii\queue\file\Queue
reserve()	Reserves message for execute	yii\queue\file\Queue
runWorker()	Runs worker.	yii\queue\cli\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
STATUS_DONE	3	yii\queue\Queue
STATUS_RESERVED	2	yii\queue\Queue
STATUS_WAITING	1	yii\queue\Queue

Property Details

$commandClass public property

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

$dirMode public property

public integer $dirMode = 0755

$fileMode public property

public integer|null $fileMode = null

$indexDeserializer public property

public callable $indexDeserializer = 'unserialize'

$indexSerializer public property

public callable $indexSerializer = 'serialize'

$path public property

public string $path = '@runtime/queue'

Method Details

clear() public method (available since version 2.0.1)

Clears the queue

public void clear ( )

delete() protected method

Deletes reserved message

protected void delete ( $payload )
$payload	array

init() public method

public void init ( )

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

remove() public method (available since version 2.0.1)

Removes a job by ID

public boolean remove ( $id )
$id	integer	Of a job

reserve() protected method

Reserves message for execute

protected array\|null reserve ( )
return	array\|null	Payload

run() public method (available since version 2.0.2)

Listens queue and runs each job.

public null\|integer run ( $repeat, $delay = 0 )
$repeat	boolean	Whether to continue listening when queue is empty.
$delay	integer	Number of seconds to sleep before next iteration.
return	null\|integer	Exit code.

status() public method

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