timer

README

timer

Golang timer with start and pause

Documentation

Index

• type Timer
  • func AfterFunc(d time.Duration, f func()) *Timer
  • func NewTimer(d time.Duration) *Timer
  • func (t *Timer) Pause() bool
  • func (t *Timer) Paused() bool
  • func (t *Timer) SetTimeLeft(d time.Duration) bool
  • func (t *Timer) Start() bool
  • func (t *Timer) Stop() bool
  • func (t *Timer) TimeLeft() time.Duration

Types

type Timer

type Timer struct {
	C <-chan time.Time
	// contains filtered or unexported fields
}

The Timer type represents a single event. When the Timer expires, the current time will be sent on C, unless the Timer was created by AfterFunc. A Timer must be created with NewTimer or AfterFunc.

func AfterFunc

func AfterFunc(d time.Duration, f func()) *Timer

AfterFunc waits after calling its Start method for the duration to elapse and then calls f in its own goroutine. It returns a Timer that can be used to cancel the call using its Stop method, or pause using its Pause method

func NewTimer

func NewTimer(d time.Duration) *Timer

NewTimer creates a new Timer. It returns a Timer that can be used to cancel the call using its Stop method, or pause using its Pause method

func (*Timer) Pause

func (t *Timer) Pause() bool

Pause pauses current timer until Start method will be called. Next Start call will wait rest of duration.

func (*Timer) Paused

func (t *Timer) Paused() bool

Paused returns true if the timer is in idle state, either because Start() hasn't been called yet or because Pause() was called.

func (*Timer) SetTimeLeft

func (t *Timer) SetTimeLeft(d time.Duration) bool

SetTimeLeft adjusts the point in time the timer will fire to duration d from now. It returns false if the timer already expired, true otherwise.

func (*Timer) Start

func (t *Timer) Start() bool

Start starts Timer that will send the current time on its channel after at least duration d.

func (*Timer) Stop

func (t *Timer) Stop() bool

Stop prevents the Timer from firing. It returns true if the call stops the timer, false if the timer has already expired or been stopped. Stop does not close the channel, to prevent a read from the channel succeeding incorrectly.

func (*Timer) TimeLeft

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

TimeLeft returns the duration left to run before the timer expires. TimeLeft is safe to be called on a nil timer and will return 0 in that case.