timer

Documentation

Index

• Variables
• type SleepConsumer
• type TimeProvider
• type Timer
  • func NewTimer() Timer
  • func (t *Timer) Delta() time.Duration
  • func (t *Timer) Elapsed() time.Duration
  • func (t *Timer) Running() bool
  • func (t *Timer) Start() error
  • func (t *Timer) Stop() error
  • func (t *Timer) WaitTill(duration time.Duration) error
  • func (t *Timer) WaitTillNextFullSecond() error

Variables

var SysSleepConsumer = func(d time.Duration) { time.Sleep(d) }

SysSleepConsumer is the default system sleep consumer

var SysTimeProvider = func() time.Time { return time.Now() }

SysTimeProvider is the default system time provider

Types

type SleepConsumer

type SleepConsumer func(time.Duration)

SleepConsumer sleeps the given amount of time. This is usually the time.Sleep method, but can be something else for unit tests.

type TimeProvider

type TimeProvider func() time.Time

A TimeProvider returns the current time. This is usually the system time, but can be something else for unit tests.

type Timer

type Timer struct {
	TimeProvider  TimeProvider
	SleepConsumer SleepConsumer
	// contains filtered or unexported fields
}

A Timer can be started and stopped. It will start at zero and count up, while running. It is event driven, there are now threads that update any state.

func NewTimer

func NewTimer() Timer

NewTimer creates a new stopped timer based on system time

func (*Timer) Delta

func (t *Timer) Delta() time.Duration

Delta returns the time since last call to Delta

func (*Timer) Elapsed

func (t *Timer) Elapsed() time.Duration

Elapsed returns the elapsed time of this timer

func (*Timer) Running

func (t *Timer) Running() bool

Running returns if timer is currently running

func (*Timer) Start

func (t *Timer) Start() error

Start capturing the time

func (*Timer) Stop

func (t *Timer) Stop() error

Stop capturing the time

func (*Timer) WaitTill

func (t *Timer) WaitTill(duration time.Duration) error

WaitTill waits until the internal timer duration is reached.

func (*Timer) WaitTillNextFullSecond

func (t *Timer) WaitTillNextFullSecond() error

WaitTillNextFullSecond waits until the internal timer has reached the next full second