ILBFactory.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;
 
use InvalidArgumentException;
 
interface ILBFactory {
    public const SHUTDOWN_NO_CHRONPROT = 0; // don't save DB positions at all
    public const SHUTDOWN_CHRONPROT_ASYNC = 1;
    public const SHUTDOWN_CHRONPROT_SYNC = 2;
 
    public const CLUSTER_MAIN_DEFAULT = 'DEFAULT';
 
    public function __construct( array $conf );
 
    public function destroy();
 
    public function getLocalDomainID();
 
    public function resolveDomainID( $domain );
 
    public function redefineLocalDomain( $domain );
 
    public function newMainLB( $domain = false, $owner = null );
 
    public function getMainLB( $domain = false );
 
    public function newExternalLB( $cluster, $owner = null );
 
    public function getExternalLB( $cluster );
 
    public function getAllMainLBs();
 
    public function getAllExternalLBs();
 
    public function forEachLB( $callback, array $params = [] );
 
    public function shutdown(
        $mode = self::SHUTDOWN_CHRONPROT_SYNC,
        callable $workCallback = null,
        &$cpIndex = null,
        &$cpClientId = null
    );
 
    public function flushReplicaSnapshots( $fname = __METHOD__ );
 
    public function commitAll( $fname = __METHOD__, array $options = [] );
 
    public function beginMasterChanges( $fname = __METHOD__ );
 
    public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
 
    public function rollbackMasterChanges( $fname = __METHOD__ );
 
    public function hasTransactionRound();
 
    public function isReadyForRoundOperations();
 
    public function hasMasterChanges();
 
    public function laggedReplicaUsed();
 
    public function hasOrMadeRecentMasterChanges( $age = null );
 
    public function waitForReplication( array $opts = [] );
 
    public function setWaitForReplicationListener( $name, callable $callback = null );
 
    public function getEmptyTransactionTicket( $fname );
 
    public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
 
    public function getChronologyProtectorTouched( $domain = false );
 
    public function disableChronologyProtection();
 
    public function setLocalDomainPrefix( $prefix );
 
    public function closeAll();
 
    public function setAgentName( $agent );
 
    public function appendShutdownCPIndexAsQuery( $url, $index );
 
    public function getChronologyProtectorClientId();
 
    public function setRequestInfo( array $info );
 
    public function setDefaultReplicationWaitTimeout( $seconds );
 
    public function setTableAliases( array $aliases );
 
    public function setIndexAliases( array $aliases );
 
    public function setDomainAliases( array $aliases );
 
    public function getTransactionProfiler(): TransactionProfiler;
}