ticker

Documentation

Index

• type Ticker
  • func New(intervals time.Duration) *Ticker
  • func (t *Ticker) Start()
  • func (t *Ticker) Stop()
  • func (t *Ticker) Ticking() bool

Types

type Ticker

type Ticker struct {
	Ticks chan time.Time
	// contains filtered or unexported fields
}

Ticker defines time ticker that delivers ticks at intervals

func New

func New(intervals time.Duration) *Ticker

New creates an instance of Ticker that ticks every intervals. It includes some kind of back-pressure for slow receivers

func (*Ticker) Start

func (t *Ticker) Start()

Start the ticker. Ticks are delivered on the ticker's channel until Stop is called

func (*Ticker) Stop

func (t *Ticker) Stop()

Stop stops the ticker. No ticks will be delivered on ticker's channel after Stop returns and before Start is call again

func (*Ticker) Ticking

func (t *Ticker) Ticking() bool

Ticking returns true when the ticker is ticking and false when it is stopped