github.com/matrixorigin/matrixone@v1.2.0/pkg/txn/clock/types.go (about)

     1  // Copyright 2022 Matrix Origin
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package clock
    16  
    17  import (
    18  	"time"
    19  
    20  	"github.com/matrixorigin/matrixone/pkg/pb/timestamp"
    21  )
    22  
    23  // Clock is the interface to the clock used in MatrixOne's timestamp ordering
    24  // based transaction module.
    25  type Clock interface {
    26  	// HasNetworkLatency returns a boolean value indicating whether there is network
    27  	// latency involved when retrieving timestamps.
    28  	HasNetworkLatency() bool
    29  	// MaxOffset returns the max offset of the physical clocks in the cluster.
    30  	MaxOffset() time.Duration
    31  	// Now returns the current timestamp and the upper bound of the current time
    32  	// caused by clock offset.
    33  	Now() (timestamp.Timestamp, timestamp.Timestamp)
    34  	// Update updates the clock based on the received timestamp.
    35  	Update(ts timestamp.Timestamp)
    36  
    37  	// SetNodeID set node id. Just used to compatible with TAE some constraint to guaranteed
    38  	// unique timestamp.
    39  	SetNodeID(id uint16)
    40  }