NullJob Class Reference

No-op job that does nothing. More...

Inherits Job, and GenericParameterJob.

Collaboration diagram for NullJob:

Public Member Functions
	__construct (array $params)
	run ()
	Run the job.
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	allowRetries ()
	Warning In some setups (i.e. when using change-propagation) jobs may still be retried even when this is false if the job fails due to a timeout unless it is also configured in change-prop config (T358939). Returns bool Whether this job can be retried on failure by job runners Since 1.21
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string
	getMetadata ( $field=null)
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26
	getReleaseTimestamp ()
	getRequestId ()
	Returns string|null Id of the request that created this job. Follows jobs recursively, allowing to track the id of the request that started a job when jobs insert jobs which insert other jobs. Since 1.27
	getRootJobParams ()
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31
	hasRootJobParams ()
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	setMetadata ( $field, $value)
	teardown ( $status)
	toString ()
	Returns string Debugging string describing the job
	workItemCount ()
Public Member Functions inherited from RunnableJob
	tearDown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

Additional Inherited Members
Static Public Member Functions inherited from Job
static	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job.
static	newRootJobParams ( $key)
	Get "root job" parameters for a task.
Public Attributes inherited from Job
string	$command
array	$metadata = []
	Additional queue metadata.
array	$params
	Array of job parameters.
Protected Member Functions inherited from Job
	addTeardownCallback ( $callback)
	setLastError ( $error)
Protected Attributes inherited from Job
string	$error
	Text for error that occurred last.
int	$executionFlags = 0
	Bitfield of JOB_* class constants.
bool	$removeDuplicates = false
	Expensive jobs may set this to true.
callable[]	$teardownCallbacks = []
Title	$title

Detailed Description

No-op job that does nothing.

This is used for testing purposes, e.g. to measure overall system performance of the JobQueue system, lock contention, etc.

This job can optionally recursively re-queue itself a number of times or spend a fixed amount of time idling in execution time.

Example:

Inserting a null job in the configured job queue:

$ php maintenance/eval.php
> $queue = MediaWikiServices::getInstance()->getJobQueueGroup();
> $job = new NullJob( [ 'lives' => 10 ] );
> $queue->push( $job );

You can confirm the job has been enqueued via maintenance/showJobs.php:

$ php maintenance/showJobs.php --group
null: 1 queue; 0 claimed (0 active, 0 abandoned)

Definition at line 50 of file NullJob.php.

Constructor & Destructor Documentation

__construct()

NullJob::__construct

(

array

$params

)

Parameters

array

$params

Job parameters (lives, usleep)

Implements GenericParameterJob.

Definition at line 54 of file NullJob.php.

References $params.

Member Function Documentation

run()

NullJob::run

(

)

Run the job.

Returns

bool Success

Implements RunnableJob.

Definition at line 65 of file NullJob.php.

References $job, and $params.

---

The documentation for this class was generated from the following file:

• includes/jobqueue/jobs/NullJob.php