A simple single-master LBFactory that gets its configuration from the b/c globals. More...

Inheritance diagram for LBFactorySimple:

[legend]

Collaboration diagram for LBFactorySimple:

[legend]

Public Member Functions
	__construct (array $conf)

	forEachLB ( $callback, array $params=[])
	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.

	getExternalLB ( $cluster)

	getMainLB ( $domain=false)

	newExternalLB ( $cluster)

	newMainLB ( $domain=false)

Public Member Functions inherited from LBFactory
	__destruct ()

	appendPreShutdownTimeAsQuery ( $url, $time)
	Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed.

	beginMasterChanges ( $fname=__METHOD__)
	Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)

	closeAll ()
	Close all open database connections on all open load balancers.

	commitAll ( $fname=__METHOD__, array $options=[])
	Commit open transactions on all connections.

	commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
	Convenience method for safely running commitMasterChanges()/waitForReplication()

	commitMasterChanges ( $fname=__METHOD__, array $options=[])
	Commit changes on all master connections.

	destroy ()
	Disables all load balancers.

	disableChronologyProtection ()
	Disable the ChronologyProtector for all load balancers.

	flushReplicaSnapshots ( $fname=__METHOD__)
	Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.

	getChronologyProtectorTouched ( $dbName)

	getEmptyTransactionTicket ( $fname)
	Get a token asserting that no transaction writes are active.

	hasMasterChanges ()
	Determine if any master connection has pending changes.

	hasOrMadeRecentMasterChanges ( $age=null)
	Determine if any master connection has pending/written changes from this request.

	hasTransactionRound ()
	Check if a transaction round is active.

	laggedReplicaUsed ()
	Detemine if any lagged replica DB connection was used.

	rollbackMasterChanges ( $fname=__METHOD__)
	Rollback changes on all master connections.

	setAgentName ( $agent)

	setDomainPrefix ( $prefix)
	Set a new table prefix for the existing local domain ID for testing.

	setRequestInfo (array $info)

	setWaitForReplicationListener ( $name, callable $callback=null)
	Add a callback to be run in every call to waitForReplication() before waiting.

	shutdown ( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null)
	Prepare all tracked load balancers for shutdown.

	waitForReplication (array $opts=[])
	Waits for the replica DBs to catch up to the current master position.

Private Member Functions
	newLoadBalancer (array $servers)

Private Attributes
array[]	$externalClusters = []
	Map of (cluster => (server index => server config))

LoadBalancer[]	$extLBs = []

string	$loadMonitorClass

LoadBalancer	$mainLB

array[]	$servers = []
	Map of (server index => server config)

Additional Inherited Members
Public Attributes inherited from ILBFactory
const	SHUTDOWN_CHRONPROT_ASYNC = 1

const	SHUTDOWN_CHRONPROT_SYNC = 2

const	SHUTDOWN_NO_CHRONPROT = 0

Protected Member Functions inherited from LBFactory
	baseLoadBalancerParams ()
	Base parameters to LoadBalancer::__construct()

	forEachLBCallMethod ( $methodName, array $args=[])
	Call a method of each tracked load balancer.

	getChronologyProtector ()

	getScopedPHPBehaviorForCommit ()
	Make PHP ignore user aborts/disconnects until the returned value leaves scope.

	initLoadBalancer (ILoadBalancer $lb)

	shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, $mode)
	Get and record all of the staged DB positions into persistent memory storage.

Protected Attributes inherited from LBFactory
string	$agent
	Agent name for query profiling.

ChronologyProtector	$chronProt

bool	$cliMode
	Whether this PHP instance is for a CLI script.

LoggerInterface	$connLogger

callable	$errorLogger
	Error logger.

string	$hostname
	Local hostname of the app server.

DatabaseDomain	$localDomain
	Local domain.

BagOStuff	$memCache

LoggerInterface	$perfLogger

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

string bool	$readOnlyReason = false
	Reason all LBs are read-only or false if not.

callable[]	$replicationWaitCallbacks = []

LoggerInterface	$replLogger

array	$requestInfo
	Web request information about the client.

BagOStuff	$srvCache

mixed	$ticket

TransactionProfiler	$trxProfiler

string bool	$trxRoundId = false
	String if a requested DBO_TRX transaction round is active.

WANObjectCache	$wanCache

Detailed Description

A simple single-master LBFactory that gets its configuration from the b/c globals.

Definition at line 27 of file LBFactorySimple.php.

Constructor & Destructor Documentation

◆ __construct()

LBFactorySimple::__construct ( array $conf )

See also: LBFactory::__construct()

Parameters

array

$conf

Parameters of LBFactory::__construct() as well as:

servers : list of server configuration maps to Database::factory(). Additionally, the server maps should have a 'load' key, which is used to decide how often clients connect to one server verses the others. A 'max lag' key should also be set on server maps, indicating how stale the data can be before the load balancer tries to avoid using it. The map can have 'is static' set to disable blocking replication sync checks (intended for archive servers with unchanging data).
externalClusters : map of cluster names to server arrays. The servers arrays have the same format as "servers" above.

Reimplemented from LBFactory.

Definition at line 53 of file LBFactorySimple.php.

References as, and servers.

Member Function Documentation

◆ forEachLB()

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

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

callable	$callback
array	$params

Implements ILBFactory.

Definition at line 132 of file LBFactorySimple.php.

References $params, and as.

◆ getExternalLB()

LBFactorySimple::getExternalLB ( $cluster )

See also: ILBFactory::getExternalLB()

Parameters

string $cluster

Returns: LoadBalancer

Reimplemented from LBFactory.

Definition at line 102 of file LBFactorySimple.php.

References LBFactory\getChronologyProtector(), and newExternalLB().

◆ getMainLB()

LBFactorySimple::getMainLB ( $domain = false )

Parameters

bool | string $domain

Returns: LoadBalancer

Reimplemented from LBFactory.

Definition at line 85 of file LBFactorySimple.php.

References $mainLB, LBFactory\getChronologyProtector(), and newMainLB().

◆ newExternalLB()

LBFactorySimple::newExternalLB ( $cluster )

See also: ILBFactory::newExternalLB()

Parameters

string $cluster

Returns: LoadBalancer

Reimplemented from LBFactory.

Definition at line 94 of file LBFactorySimple.php.

References newLoadBalancer().

Referenced by getExternalLB().

◆ newLoadBalancer()

LBFactorySimple::newLoadBalancer ( array $servers )

private

Definition at line 111 of file LBFactorySimple.php.

References LBFactory\baseLoadBalancerParams(), and LBFactory\initLoadBalancer().

Referenced by newExternalLB(), and newMainLB().

◆ newMainLB()

LBFactorySimple::newMainLB ( $domain = false )

Parameters

bool | string $domain

Returns: LoadBalancer

Reimplemented from LBFactory.

Definition at line 77 of file LBFactorySimple.php.

References newLoadBalancer(), and servers.

Referenced by getMainLB().

Member Data Documentation

◆ $externalClusters

array [] LBFactorySimple::$externalClusters = []

private

Map of (cluster => (server index => server config))

Definition at line 36 of file LBFactorySimple.php.

◆ $extLBs

LoadBalancer [] LBFactorySimple::$extLBs = []

private

Definition at line 31 of file LBFactorySimple.php.

◆ $loadMonitorClass

string LBFactorySimple::$loadMonitorClass

private

Definition at line 39 of file LBFactorySimple.php.

◆ $mainLB

LoadBalancer LBFactorySimple::$mainLB

private

Definition at line 29 of file LBFactorySimple.php.

Referenced by getMainLB().

◆ $servers

array [] LBFactorySimple::$servers = []

private

Map of (server index => server config)

Definition at line 34 of file LBFactorySimple.php.

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

includes/libs/rdbms/lbfactory/LBFactorySimple.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ forEachLB()

◆ getExternalLB()

◆ getMainLB()

◆ newExternalLB()

◆ newLoadBalancer()

◆ newMainLB()

Member Data Documentation

◆ $externalClusters

◆ $extLBs

◆ $loadMonitorClass

◆ $mainLB

◆ $servers