clock.go raw

   1  // Copyright (c) 2021 Uber Technologies, Inc.
   2  //
   3  // Permission is hereby granted, free of charge, to any person obtaining a copy
   4  // of this software and associated documentation files (the "Software"), to deal
   5  // in the Software without restriction, including without limitation the rights
   6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  // copies of the Software, and to permit persons to whom the Software is
   8  // furnished to do so, subject to the following conditions:
   9  //
  10  // The above copyright notice and this permission notice shall be included in
  11  // all copies or substantial portions of the Software.
  12  //
  13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  // THE SOFTWARE.
  20  
  21  package zapcore
  22  
  23  import "time"
  24  
  25  // DefaultClock is the default clock used by Zap in operations that require
  26  // time. This clock uses the system clock for all operations.
  27  var DefaultClock = systemClock{}
  28  
  29  // Clock is a source of time for logged entries.
  30  type Clock interface {
  31  	// Now returns the current local time.
  32  	Now() time.Time
  33  
  34  	// NewTicker returns *time.Ticker that holds a channel
  35  	// that delivers "ticks" of a clock.
  36  	NewTicker(time.Duration) *time.Ticker
  37  }
  38  
  39  // systemClock implements default Clock that uses system time.
  40  type systemClock struct{}
  41  
  42  func (systemClock) Now() time.Time {
  43  	return time.Now()
  44  }
  45  
  46  func (systemClock) NewTicker(duration time.Duration) *time.Ticker {
  47  	return time.NewTicker(duration)
  48  }
  49