Files
mochi/pkg/timecache/timecache.go
Lawrence, Rendall 5513f1357d fix lint warnings
replace naked returns with arguments (gofumpt@v0.9.1)
2025-09-22 17:11:05 +03:00

108 lines
2.6 KiB
Go

// Package timecache provides a cache for the system clock, to avoid calls to
// time.Now().
// The time is stored as one int64 which holds the number of nanoseconds since
// the Unix Epoch. The value is accessed using atomic primitives, without
// locking.
// The package runs a global singleton TimeCache that is updated every
// second.
package timecache
import (
"sync"
"sync/atomic"
"time"
)
// t is the global TimeCache.
var t *TimeCache
func init() {
t = New()
go t.Run(1 * time.Second)
}
// A TimeCache is a cache for the current system time.
// The cached time has nanosecond precision.
type TimeCache struct {
// clock saves the current time's nanoseconds since the Epoch.
// Must be accessed atomically.
clock atomic.Int64
closed chan struct{}
onceExecutor sync.Once
onceStopper sync.Once
}
// New returns a new TimeCache instance.
// The TimeCache must be started to update the time.
func New() (tc *TimeCache) {
tc = &TimeCache{closed: make(chan struct{})}
tc.clock.Store(time.Now().UnixNano())
return tc
}
// Run runs the TimeCache, updating the cached clock value once every interval
// and blocks until Stop is called.
func (t *TimeCache) Run(interval time.Duration) {
t.onceExecutor.Do(func() {
t.clock.Store(time.Now().UnixNano()) // refreshing clock after New till next tick
tick := time.NewTicker(interval)
defer tick.Stop()
for {
select {
case <-t.closed:
return
case now := <-tick.C:
t.clock.Store(now.UnixNano())
}
}
})
}
// Stop stops the TimeCache.
// The cached time remains valid but will not be updated anymore.
// A TimeCache can not be restarted. Construct a new one instead.
// Calling Stop again is a no-op.
func (t *TimeCache) Stop() {
t.onceStopper.Do(func() {
close(t.closed)
})
}
// Now returns the cached time as a time.Time value.
func (t *TimeCache) Now() time.Time {
return time.Unix(0, t.NowUnixNano())
}
// NowUnixNano returns the cached time as nanoseconds since the Unix Epoch.
func (t *TimeCache) NowUnixNano() int64 {
return t.clock.Load()
}
// NowUnix returns the cached time as seconds since the Unix Epoch.
func (t *TimeCache) NowUnix() int64 {
// Adopted from time.Unix
nsec := t.NowUnixNano()
sec := nsec / 1e9
nsec -= sec * 1e9
if nsec < 0 {
sec--
}
return sec
}
// Now calls TimeCache.Now on the global TimeCache instance.
func Now() time.Time {
return t.Now()
}
// NowUnixNano calls TimeCache.NowUnixNano on the global TimeCache instance.
func NowUnixNano() int64 {
return t.NowUnixNano()
}
// NowUnix calls TimeCache.NowUnix on the global TimeCache instance.
func NowUnix() int64 {
return t.NowUnix()
}