MediaWiki REL1_28
ILBFactory.php
Go to the documentation of this file.
1<?php
29interface ILBFactory {
30 const SHUTDOWN_NO_CHRONPROT = 0; // don't save DB positions at all
31 const SHUTDOWN_CHRONPROT_ASYNC = 1; // save DB positions, but don't wait on remote DCs
32 const SHUTDOWN_CHRONPROT_SYNC = 2; // save DB positions, waiting on all DCs
33
56 public function __construct( array $conf );
57
63 public function destroy();
64
77 public function newMainLB( $domain = false );
78
85 public function getMainLB( $domain = false );
86
99 public function newExternalLB( $cluster );
100
107 public function getExternalLB( $cluster );
108
117 public function forEachLB( $callback, array $params = [] );
118
124 public function shutdown(
125 $mode = self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback = null
126 );
127
133 public function flushReplicaSnapshots( $fname = __METHOD__ );
134
143 public function commitAll( $fname = __METHOD__, array $options = [] );
144
158 public function beginMasterChanges( $fname = __METHOD__ );
159
167 public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
168
173 public function rollbackMasterChanges( $fname = __METHOD__ );
174
180 public function hasTransactionRound();
181
186 public function hasMasterChanges();
187
192 public function laggedReplicaUsed();
193
199 public function hasOrMadeRecentMasterChanges( $age = null );
200
224 public function waitForReplication( array $opts = [] );
225
234 public function setWaitForReplicationListener( $name, callable $callback = null );
235
243
254 public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
255
260 public function getChronologyProtectorTouched( $dbName );
261
268
274 public function setDomainPrefix( $prefix );
275
279 public function closeAll();
280
284 public function setAgentName( $agent );
285
295 public function appendPreShutdownTimeAsQuery( $url, $time );
296
303 public function setRequestInfo( array $info );
304}
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition Setup.php:36
the array() calling protocol came about after MediaWiki 1.4rc1.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1752
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1096
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
An interface for generating database load balancers.
setWaitForReplicationListener( $name, callable $callback=null)
Add a callback to be run in every call to waitForReplication() before waiting.
beginMasterChanges( $fname=__METHOD__)
Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
commitAndWaitForReplication( $fname, $ticket, array $opts=[])
Convenience method for safely running commitMasterChanges()/waitForReplication()
commitMasterChanges( $fname=__METHOD__, array $options=[])
Commit changes on all master connections.
hasMasterChanges()
Determine if any master connection has pending changes.
hasOrMadeRecentMasterChanges( $age=null)
Determine if any master connection has pending/written changes from this request.
setDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
forEachLB( $callback, array $params=[])
Execute a function for each tracked load balancer The callback is called with the load balancer as th...
getEmptyTransactionTicket( $fname)
Get a token asserting that no transaction writes are active.
getMainLB( $domain=false)
Get a cached (tracked) load balancer object.
const SHUTDOWN_CHRONPROT_ASYNC
newExternalLB( $cluster)
Create a new load balancer for external storage.
hasTransactionRound()
Check if a transaction round is active.
disableChronologyProtection()
Disable the ChronologyProtector for all load balancers.
setAgentName( $agent)
commitAll( $fname=__METHOD__, array $options=[])
Commit open transactions on all connections.
rollbackMasterChanges( $fname=__METHOD__)
Rollback changes on all master connections.
const SHUTDOWN_CHRONPROT_SYNC
destroy()
Disables all load balancers.
waitForReplication(array $opts=[])
Waits for the replica DBs to catch up to the current master position.
newMainLB( $domain=false)
Create a new load balancer object.
__construct(array $conf)
Construct a manager of ILoadBalancer objects.
getExternalLB( $cluster)
Get a cached (tracked) load balancer for external storage.
const SHUTDOWN_NO_CHRONPROT
getChronologyProtectorTouched( $dbName)
closeAll()
Close all open database connections on all open load balancers.
setRequestInfo(array $info)
appendPreShutdownTimeAsQuery( $url, $time)
Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed.
laggedReplicaUsed()
Detemine if any lagged replica DB connection was used.
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
shutdown( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null)
Prepare all tracked load balancers for shutdown.
$params