timer

Documentation

Index

• type Timer
  • func NewStagedTimer(f func() (time.Duration, bool)) *Timer
  • func NewTimer(handler func()) *Timer
  • func (t *Timer) Cancel()
  • func (t *Timer) Dispatch()
  • func (t *Timer) SetTimeoutIn(duration time.Duration)
  • func (t *Timer) Stop()

Types

type Timer

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

Timer wraps a timer object. This allows a user to specify a handler. Once specifying the handler, the dispatch thread can be called. The dispatcher will only return after calling Stop. SetTimeoutIn will result in calling the handler in the specified amount of time.

func NewStagedTimer

func NewStagedTimer(f func() (time.Duration, bool)) *Timer

NewStagedTimer returns a timer that will execute [f] when a timeout occurs and execute an additional timeout after the returned duration if [f] returns true and some duration.

func NewTimer

func NewTimer(handler func()) *Timer

NewTimer creates a new timer object

func (*Timer) Cancel

func (t *Timer) Cancel()

Cancel the currently scheduled event

func (*Timer) Dispatch

func (t *Timer) Dispatch()

func (*Timer) SetTimeoutIn

func (t *Timer) SetTimeoutIn(duration time.Duration)

SetTimeoutIn will set the timer to fire the handler in [duration]

func (*Timer) Stop

func (t *Timer) Stop()

Stop this timer from executing any more.