mclock

package
Version: v1.10.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2021 License: GPL-3.0 Imports: 4 Imported by: 660

Documentation

Overview

Package mclock is a wrapper for a monotonic clock source

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbsTime

type AbsTime int64

AbsTime represents absolute monotonic time.

func Now

func Now() AbsTime

Now returns the current absolute monotonic time.

func (AbsTime) Add added in v1.8.14

func (t AbsTime) Add(d time.Duration) AbsTime

Add returns t + d as absolute time.

func (AbsTime) Sub added in v1.9.11

func (t AbsTime) Sub(t2 AbsTime) time.Duration

Sub returns t - t2 as a duration.

type ChanTimer added in v1.9.11

type ChanTimer interface {
	Timer

	// The channel returned by C receives a value when the timer expires.
	C() <-chan AbsTime
	// Reset reschedules the timer with a new timeout.
	// It should be invoked only on stopped or expired timers with drained channels.
	Reset(time.Duration)
}

ChanTimer is a cancellable event created by NewTimer.

type Clock added in v1.8.14

type Clock interface {
	Now() AbsTime
	Sleep(time.Duration)
	NewTimer(time.Duration) ChanTimer
	After(time.Duration) <-chan AbsTime
	AfterFunc(d time.Duration, f func()) Timer
}

The Clock interface makes it possible to replace the monotonic system clock with a simulated clock.

type Simulated added in v1.8.14

type Simulated struct {
	// contains filtered or unexported fields
}

Simulated implements a virtual Clock for reproducible time-sensitive tests. It simulates a scheduler on a virtual timescale where actual processing takes zero time.

The virtual clock doesn't advance on its own, call Run to advance it and execute timers. Since there is no way to influence the Go scheduler, testing timeout behaviour involving goroutines needs special care. A good way to test such timeouts is as follows: First perform the action that is supposed to time out. Ensure that the timer you want to test is created. Then run the clock until after the timeout. Finally observe the effect of the timeout using a channel or semaphore.

func (*Simulated) ActiveTimers added in v1.8.14

func (s *Simulated) ActiveTimers() int

ActiveTimers returns the number of timers that haven't fired.

func (*Simulated) After added in v1.8.14

func (s *Simulated) After(d time.Duration) <-chan AbsTime

After returns a channel which receives the current time after the clock has advanced by d.

func (*Simulated) AfterFunc added in v1.9.2

func (s *Simulated) AfterFunc(d time.Duration, fn func()) Timer

AfterFunc runs fn after the clock has advanced by d. Unlike with the system clock, fn runs on the goroutine that calls Run.

func (*Simulated) NewTimer added in v1.9.11

func (s *Simulated) NewTimer(d time.Duration) ChanTimer

NewTimer creates a timer which fires when the clock has advanced by d.

func (*Simulated) Now added in v1.8.14

func (s *Simulated) Now() AbsTime

Now returns the current virtual time.

func (*Simulated) Run added in v1.8.14

func (s *Simulated) Run(d time.Duration)

Run moves the clock by the given duration, executing all timers before that duration.

func (*Simulated) Sleep added in v1.8.14

func (s *Simulated) Sleep(d time.Duration)

Sleep blocks until the clock has advanced by d.

func (*Simulated) WaitForTimers added in v1.8.14

func (s *Simulated) WaitForTimers(n int)

WaitForTimers waits until the clock has at least n scheduled timers.

type System added in v1.8.14

type System struct{}

System implements Clock using the system clock.

func (System) After added in v1.8.14

func (c System) After(d time.Duration) <-chan AbsTime

After returns a channel which receives the current time after d has elapsed.

func (System) AfterFunc added in v1.9.2

func (c System) AfterFunc(d time.Duration, f func()) Timer

AfterFunc runs f on a new goroutine after the duration has elapsed.

func (System) NewTimer added in v1.9.11

func (c System) NewTimer(d time.Duration) ChanTimer

NewTimer creates a timer which can be rescheduled.

func (System) Now added in v1.8.14

func (c System) Now() AbsTime

Now returns the current monotonic time.

func (System) Sleep added in v1.8.14

func (c System) Sleep(d time.Duration)

Sleep blocks for the given duration.

type Timer added in v1.9.4

type Timer interface {
	// Stop cancels the timer. It returns false if the timer has already
	// expired or been stopped.
	Stop() bool
}

Timer is a cancellable event created by AfterFunc.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL