ILoadBalancer.php

Go to the documentation of this file.

<?php
interface ILoadBalancer {
    const DB_REPLICA = -1;
    const DB_MASTER = -2;

    const DOMAIN_ANY = '';

    public function __construct( array $params );

    public function getReaderIndex( $group = false, $domain = false );

    public function waitFor( $pos );

    public function waitForOne( $pos, $timeout = null );

    public function waitForAll( $pos, $timeout = null );

    public function getAnyOpenConnection( $i );

    public function getConnection( $i, $groups = [], $domain = false );

    public function reuseConnection( $conn );

    public function getConnectionRef( $db, $groups = [], $domain = false );

    public function getLazyConnectionRef( $db, $groups = [], $domain = false );

    public function openConnection( $i, $domain = false );

    public function getWriterIndex();

    public function haveIndex( $i );

    public function isNonZeroLoad( $i );

    public function getServerCount();

    public function getServerName( $i );

    public function getServerInfo( $i );

    public function setServerInfo( $i, array $serverInfo );

    public function getMasterPos();

    public function disable();

    public function closeAll();

    public function closeConnection( IDatabase $conn );

    public function commitAll( $fname = __METHOD__ );

    public function finalizeMasterChanges();

    public function approveMasterChanges( array $options );

    public function beginMasterChanges( $fname = __METHOD__ );

    public function commitMasterChanges( $fname = __METHOD__ );

    public function runMasterPostTrxCallbacks( $type );

    public function rollbackMasterChanges( $fname = __METHOD__ );

    public function suppressTransactionEndCallbacks();

    public function flushReplicaSnapshots( $fname = __METHOD__ );

    public function hasMasterConnection();

    public function hasMasterChanges();

    public function lastMasterChangeTimestamp();

    public function hasOrMadeRecentMasterChanges( $age = null );

    public function pendingMasterChangeCallers();

    public function getLaggedReplicaMode( $domain = false );

    public function laggedReplicaUsed();

    public function getReadOnlyReason( $domain = false, IDatabase $conn = null );

    public function allowLagged( $mode = null );

    public function pingAll();

    public function forEachOpenConnection( $callback, array $params = [] );

    public function forEachOpenMasterConnection( $callback, array $params = [] );

    public function forEachOpenReplicaConnection( $callback, array $params = [] );

    public function getMaxLag( $domain = false );

    public function getLagTimes( $domain = false );

    public function safeGetLag( IDatabase $conn );

    public function safeWaitForMasterPos( IDatabase $conn, $pos = false, $timeout = null );

    public function setTransactionListener( $name, callable $callback = null );

    public function setDomainPrefix( $prefix );

    public function setTableAliases( array $aliases );
}