go.temporal.io/server@v1.23.0/common/clock/time_source.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  // Package clock provides extensions to the [time] package.
    26  package clock
    27  
    28  import (
    29  	"time"
    30  )
    31  
    32  type (
    33  	// TimeSource is an interface to make it easier to test code that uses time.
    34  	TimeSource interface {
    35  		Now() time.Time
    36  		AfterFunc(d time.Duration, f func()) Timer
    37  	}
    38  	// Timer is a timer returned by TimeSource.AfterFunc. Unlike the timers returned by [time.NewTimer] or time.Ticker,
    39  	// this timer does not have a channel. That is because the callback already reacts to the timer firing.
    40  	Timer interface {
    41  		// Reset changes the expiration time of the timer. It returns true if the timer had been active, false if the
    42  		// timer had expired or been stopped.
    43  		Reset(d time.Duration) bool
    44  		// Stop prevents the Timer from firing. It returns true if the call stops the timer, false if the timer has
    45  		// already expired or been stopped.
    46  		Stop() bool
    47  	}
    48  	// RealTimeSource is a timeSource that uses the real wall timeSource time. The zero value is valid.
    49  	RealTimeSource struct{}
    50  )
    51  
    52  // NewRealTimeSource returns a timeSource that uses the real wall timeSource time.
    53  func NewRealTimeSource() RealTimeSource {
    54  	return RealTimeSource{}
    55  }
    56  
    57  // Now returns the current time, with the location set to UTC.
    58  func (ts RealTimeSource) Now() time.Time {
    59  	return time.Now().UTC()
    60  }
    61  
    62  // AfterFunc is a pass-through to time.AfterFunc.
    63  func (ts RealTimeSource) AfterFunc(d time.Duration, f func()) Timer {
    64  	return time.AfterFunc(d, f)
    65  }