An interface for generating database load balancers. More...

Inheritance diagram for LBFactory:

Public Member Functions
	__construct ($conf)
	Construct a factory based on a configuration array (typically from $wgLBFactoryConf)
	callMethod ($loadBalancer, $methodName, $args)
	Private helper for forEachLBCallMethod.
	commitMasterChanges ()
	Commit changes on all master connections.
	forEachLB ($callback, $params=array())
	Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.
	forEachLBCallMethod ($methodName, $args=array())
	Call a method of each tracked load balancer.
&	getExternalLB ($cluster, $wiki=false)
	Get a cached (tracked) load balancer for external storage.
	getMainLB ($wiki=false)
	Get a cached (tracked) load balancer object.
	newExternalLB ($cluster, $wiki=false)
	Create a new load balancer for external storage.
	newMainLB ($wiki=false)
	Create a new load balancer object.
	shutdown ()
	Prepare all tracked load balancers for shutdown STUB.
Static Public Member Functions
static	destroyInstance ()
	Shut down, close connections and destroy the cached instance.
static	disableBackend ()
	Disables all access to the load balancer, will cause all database access to throw a DBAccessError.
static	setInstance ($instance)
	Set the instance to be the given object.
static &	singleton ()
	Get an LBFactory instance.
Static Public Attributes
static	$instance

Detailed Description

An interface for generating database load balancers.

Definition at line 28 of file LBFactory.php.

Constructor & Destructor Documentation

LBFactory::__construct ( $ conf ) [abstract]

Construct a factory based on a configuration array (typically from $wgLBFactoryConf)

Parameters:

$conf

Reimplemented in LBFactory_Fake, LBFactory_Simple, LBFactory_Multi, and LBFactory_Single.

Member Function Documentation

LBFactory::callMethod	(	$	loadBalancer,
		$	methodName,
		$	args
	)

Private helper for forEachLBCallMethod.

Parameters:

$loadBalancer
$methodName	string
$args

Definition at line 155 of file LBFactory.php.

References array().

LBFactory::commitMasterChanges ( )

Commit changes on all master connections.

Definition at line 162 of file LBFactory.php.

References forEachLBCallMethod().

Referenced by LBFactory_Simple\shutdown(), and LBFactory_Multi\shutdown().

static LBFactory::destroyInstance ( ) [static]

Shut down, close connections and destroy the cached instance.

Definition at line 61 of file LBFactory.php.

Referenced by setInstance().

static LBFactory::disableBackend ( ) [static]

Disables all access to the load balancer, will cause all database access to throw a DBAccessError.

Definition at line 39 of file LBFactory.php.

References global.

LBFactory::forEachLB	(	$	callback,
		$	params = `array()`
	)		`[abstract]`

Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.

Parameters: