MediaWiki  master
ForkController Class Reference

Class for managing forking command line scripts. More...

Inheritance diagram for ForkController:

Public Member Functions

 __construct ( $numProcs, $flags=0)
 
 getChildNumber ()
 Get the number of the child currently running. More...
 
 start ()
 Start the child processes. More...
 

Public Attributes

 $childNumber = 0
 
 $procsToStart = 0
 
const RESTART_ON_ERROR = 1
 Pass this flag to __construct() to cause the class to automatically restart workers that exit with non-zero exit status or a signal such as SIGSEGV. More...
 

Protected Member Functions

 forkWorkers ( $numProcs)
 Fork a number of worker processes. More...
 
 handleTermSignal ( $signal)
 
 initChild ()
 
 prepareEnvironment ()
 

Protected Attributes

 $children = []
 
 $flags = 0
 
 $termReceived = false
 

Static Protected Attributes

static $restartableSignals
 

Detailed Description

Class for managing forking command line scripts.

Currently just does forking and process control, but it could easily be extended to provide IPC and job dispatch.

This class requires the posix and pcntl extensions.

Definition at line 33 of file ForkController.php.

Constructor & Destructor Documentation

◆ __construct()

ForkController::__construct (   $numProcs,
  $flags = 0 
)

Definition at line 56 of file ForkController.php.

References $flags, and wfIsCLI().

Member Function Documentation

◆ forkWorkers()

ForkController::forkWorkers (   $numProcs)
protected

Fork a number of worker processes.

Parameters
int$numProcs
Returns
string

Definition at line 170 of file ForkController.php.

References initChild(), and prepareEnvironment().

Referenced by start().

◆ getChildNumber()

ForkController::getChildNumber ( )

Get the number of the child currently running.

Note, this is not the pid, but rather which of the total number of children we are

Returns
int

Definition at line 148 of file ForkController.php.

References $childNumber.

◆ handleTermSignal()

ForkController::handleTermSignal (   $signal)
protected

Definition at line 202 of file ForkController.php.

◆ initChild()

ForkController::initChild ( )
protected

Definition at line 195 of file ForkController.php.

References $wgMemc, null, and wfGetCache().

Referenced by OrderedStreamingForkController\forkWorkers(), and forkWorkers().

◆ prepareEnvironment()

◆ start()

ForkController::start ( )

Start the child processes.

This should only be called from the command line. It should be called as early as possible during execution.

This will return 'child' in the child processes. In the parent process, it will run until all the child processes exit or a TERM signal is received. It will then return 'done'.

Returns
string

Definition at line 75 of file ForkController.php.

References as, and forkWorkers().

Member Data Documentation

◆ $childNumber

ForkController::$childNumber = 0

Definition at line 34 of file ForkController.php.

Referenced by getChildNumber().

◆ $children

ForkController::$children = []
protected

Definition at line 34 of file ForkController.php.

◆ $flags

ForkController::$flags = 0
protected

Definition at line 36 of file ForkController.php.

Referenced by __construct().

◆ $procsToStart

ForkController::$procsToStart = 0

Definition at line 36 of file ForkController.php.

◆ $restartableSignals

ForkController::$restartableSignals
staticprotected
Initial value:
= [
SIGFPE,
SIGILL,
SIGSEGV,
SIGBUS,
SIGABRT,
SIGSYS,
SIGPIPE,
SIGXCPU,
SIGXFSZ,
]

Definition at line 38 of file ForkController.php.

◆ $termReceived

ForkController::$termReceived = false
protected

Definition at line 35 of file ForkController.php.

◆ RESTART_ON_ERROR

const ForkController::RESTART_ON_ERROR = 1

Pass this flag to __construct() to cause the class to automatically restart workers that exit with non-zero exit status or a signal such as SIGSEGV.

Definition at line 54 of file ForkController.php.


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