NullJob Class Reference

Degenerate job that does nothing, but can optionally replace itself in the queue and/or sleep for a brief time period. More...

Inheritance diagram for NullJob:

Collaboration diagram for NullJob:

Public Member Functions
	__construct ( $title, $params)
	run ()
	Run the job. More...
Public Member Functions inherited from Job
	__construct ( $command, $title, $params=false)
	allowRetries ()
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work. More...
	getLastError ()
	getParams ()
	getReleaseTimestamp ()
	getRootJobParams ()
	getTitle ()
	getType ()
	hasRootJobParams ()
	ignoreDuplicates ()
	insert ()
	Insert a single job into the queue. More...
	toString ()
	workItemCount ()

Additional Inherited Members
Static Public Member Functions inherited from Job
static	batchInsert ( $jobs)
	Batch-insert a group of jobs into the queue. More...
static	factory ( $command, Title $title, $params=false)
	Create the appropriate object to handle a specific job. More...
static	newRootJobParams ( $key)
static	pop ()
	Pop a job off the front of the queue. More...
static	pop_type ( $type)
	Pop a job of a certain type. More...
static	safeBatchInsert ( $jobs)
	Insert a group of jobs into the queue. More...
Public Attributes inherited from Job
string	$command
array	$metadata = array()
	Additional queue metadata *. More...
array bool	$params
	Array of job parameters or false if none *. More...
Protected Member Functions inherited from Job
	setLastError ( $error)
Protected Attributes inherited from Job
string	$error
	Text for error that occurred last *. More...
bool	$removeDuplicates
	Expensive jobs may set this to true *. More...
Title	$title

Detailed Description

Degenerate job that does nothing, but can optionally replace itself in the queue and/or sleep for a brief time period.

These can be used to represent "no-op" jobs or test lock contention and performance.

Example:

Inserting a null job in the configured job queue:

$ php maintenance/eval.php
> $queue = JobQueueGroup::singleton();
> $job = new NullJob( Title::newMainPage(), array( 'lives' => 10 ) );
> $queue->push( $job );

You can then confirm the job has been enqueued by using the showJobs.php maintenance utility:

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

Definition at line 47 of file NullJob.php.

Constructor & Destructor Documentation

__construct()

NullJob::__construct	(		$title,
			$params
	)

Parameters

Title	$title
array	$params	job parameters (lives, usleep)

Definition at line 52 of file NullJob.php.

References Job\$params, and Job\$title.

Member Function Documentation

run()

NullJob::run

(

)

Run the job.

Returns

bool Success

Reimplemented from Job.

Definition at line 63 of file NullJob.php.

References $job, Job\$params, Job\$title, and JobQueueGroup\singleton().

---

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

• includes/jobqueue/jobs/NullJob.php