mclock

Documentation

Overview

Package mclock is a wrapper for a monotonic clock source

Index

• type AbsTime
  • func Now() AbsTime
  • func (t AbsTime) Add(d time.Duration) AbsTime
• type Clock
• type Event
• type Simulated
  • func (s *Simulated) ActiveTimers() int
  • func (s *Simulated) After(d time.Duration) <-chan time.Time
  • func (s *Simulated) AfterFunc(d time.Duration, do func()) Event
  • func (s *Simulated) Now() AbsTime
  • func (s *Simulated) Run(d time.Duration)
  • func (s *Simulated) Sleep(d time.Duration)
  • func (s *Simulated) WaitForTimers(n int)
• type SimulatedEvent
  • func (e *SimulatedEvent) Cancel() bool
• type System
  • func (System) After(d time.Duration) <-chan time.Time
  • func (System) AfterFunc(d time.Duration, f func()) Event
  • func (System) Now() AbsTime
  • func (System) Sleep(d time.Duration)
• type SystemEvent
  • func (e *SystemEvent) Cancel() bool

Types

type AbsTime

type AbsTime time.Duration

AbsTime represents absolute monotonic time.

func Now

func Now() AbsTime

Now returns the current absolute monotonic time.

func (AbsTime) Add

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

Add returns t + d.

type Clock

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

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

type Event

type Event interface {
	Cancel() bool
}

Event represents a cancellable event returned by AfterFunc

type Simulated

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

func (s *Simulated) ActiveTimers() int

func (*Simulated) After

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

After implements Clock.

func (*Simulated) AfterFunc

func (s *Simulated) AfterFunc(d time.Duration, do func()) Event

AfterFunc implements Clock.

func (*Simulated) Now

func (s *Simulated) Now() AbsTime

Now implements Clock.

func (*Simulated) Run

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

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

func (*Simulated) Sleep

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

Sleep implements Clock.

func (*Simulated) WaitForTimers

func (s *Simulated) WaitForTimers(n int)

type SimulatedEvent

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

SimulatedEvent implements Event for a virtual clock.

func (*SimulatedEvent) Cancel

func (e *SimulatedEvent) Cancel() bool

Cancel implements Event.

type System

type System struct{}

System implements Clock using the system clock.

func (System) After

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

After implements Clock.

func (System) AfterFunc

func (System) AfterFunc(d time.Duration, f func()) Event

AfterFunc implements Clock.

func (System) Now

func (System) Now() AbsTime

Now implements Clock.

func (System) Sleep

func (System) Sleep(d time.Duration)

Sleep implements Clock.

type SystemEvent

type SystemEvent time.Timer

SystemEvent implements Event using time.Timer.

func (*SystemEvent) Cancel

func (e *SystemEvent) Cancel() bool

Cancel implements Event.