MediaWiki  master
Wikimedia\Rdbms\DBMasterPos Interface Reference

An object representing a master or replica DB position in a replicated setup. More...

Inheritance diagram for Wikimedia\Rdbms\DBMasterPos:

Public Member Functions

 __toString ()
 
 asOfTime ()
 
 channelsMatch (DBMasterPos $pos)
 
 hasReached (DBMasterPos $pos)
 

Detailed Description

An object representing a master or replica DB position in a replicated setup.

The implementation details of this opaque type are up to the database subclass.

Definition at line 10 of file DBMasterPos.php.

Member Function Documentation

Wikimedia\Rdbms\DBMasterPos::__toString ( )
Returns
string
Since
1.27

Implemented in Wikimedia\Rdbms\MySQLMasterPos.

Wikimedia\Rdbms\DBMasterPos::asOfTime ( )
Returns
float UNIX timestamp
Since
1.25

Implemented in Wikimedia\Rdbms\MySQLMasterPos.

Wikimedia\Rdbms\DBMasterPos::channelsMatch ( DBMasterPos  $pos)
Parameters
DBMasterPos$pos
Returns
bool Whether this position appears to be for the same channel as another
Since
1.27

Implemented in Wikimedia\Rdbms\MySQLMasterPos.

Wikimedia\Rdbms\DBMasterPos::hasReached ( DBMasterPos  $pos)
Parameters
DBMasterPos$pos
Returns
bool Whether this position is at or higher than $pos
Since
1.27

Implemented in Wikimedia\Rdbms\MySQLMasterPos.

Referenced by Wikimedia\Rdbms\LoadBalancer\doWait().


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