includes/libs/rdbms/database/position/DBMasterPos.php

   1 <?php
   2
   3 namespace Wikimedia\Rdbms;
   4
   5 use Serializable;
   6
   7 /**
   8  * An object representing a master or replica DB position in a replicated setup.
   9  *
  10  * The implementation details of this opaque type are up to the database subclass.
  11  */
  12 interface DBMasterPos extends Serializable {
  13         /**
  14          * @return float UNIX timestamp
  15          * @since 1.25
  16          */
  17         public function asOfTime();
  18
  19         /**
  20          * @param DBMasterPos $pos
  21          * @return bool Whether this position is at or higher than $pos
  22          * @since 1.27
  23          */
  24         public function hasReached( DBMasterPos $pos );
  25
  26         /**
  27          * @param DBMasterPos $pos
  28          * @return bool Whether this position appears to be for the same channel as another
  29          * @since 1.27
  30          */
  31         public function channelsMatch( DBMasterPos $pos );
  32
  33         /**
  34          * @return string
  35          * @since 1.27
  36          */
  37         public function __toString();
  38 }