clock

Documentation

Overview

A clock that provides blocking calls that wait until absolute times have occurred. The clock can be controlled programmatically or be based of real time.

Index

• type Clock
  • func Fast() Clock
  • func New(start time.Time) Clock
  • func Wall() Clock
• type Setter

Types

type Clock

type Clock interface {
	Setter
	// Wait until time t has arrived. If t is in the past it immediately returns.
	Until(t time.Time)
}

A clock interface to read time and wait until an absolute time arrives. Three implementations are available: A 'wall' clock that is based on realtime, a 'fast' clock that is always ahead and a 'set' clock that can be controlled via a setting time explicitly.

func Fast

func Fast() Clock

Get a realtime fast clock.

func New

func New(start time.Time) Clock

Get a clock that can be controlled programmatically.

func Wall

func Wall() Clock

Get a realtime wall clock.

type Setter

type Setter interface {
	// Returns the start or 'zero' time of the clock
	Zero() time.Time
	// Set the time on the clock
	Set(t time.Time)
}