timer

Documentation

Overview

Package timer provides a simple wall-clock duration timer based on standard time. Accumulates total and average over multiple Start / Stop intervals. This is copied from emergent/timer, to avoid circular dependency.

Index

• type Time
  • func (t *Time) Avg() time.Duration
  • func (t *Time) AvgMSecs() float64
  • func (t *Time) AvgSecs() float64
  • func (t *Time) Reset()
  • func (t *Time) ResetStart()
  • func (t *Time) Start()
  • func (t *Time) Stop() time.Duration
  • func (t *Time) TotalSecs() float64

Types

type Time

type Time struct {

	// the most recent starting time
	St time.Time

	// the total accumulated time
	Total time.Duration

	// the number of start/stops
	N int
}

Time manages the timer accumulated time and count

func (*Time) Avg

func (t *Time) Avg() time.Duration

Avg returns the average start / stop interval (assumes each was measuring the same thing).

func (*Time) AvgMSecs

func (t *Time) AvgMSecs() float64

AvgMSecs returns the average start / stop interval as a float64 of milliseconds

func (*Time) AvgSecs

func (t *Time) AvgSecs() float64

AvgSecs returns the average start / stop interval (assumes each was measuring the same thing) as a float64 of seconds

func (*Time) Reset

func (t *Time) Reset()

Reset resets the overall accumulated Total and N counters and start time to zero

func (*Time) ResetStart

func (t *Time) ResetStart()

ResetStart reset then start the timer

func (*Time) Start

func (t *Time) Start()

Start starts the timer

func (*Time) Stop

func (t *Time) Stop() time.Duration

Stop stops the timer and accumulates the latest start - stop interval, and also returns it

func (*Time) TotalSecs

func (t *Time) TotalSecs() float64

TotalSecs returns the total start / stop intervals as a float64 of seconds.