ticker

Documentation

Index

• type Ticker
  • func New(d time.Duration, f func() error) *Ticker
  • func (t *Ticker) Reset()
  • func (t *Ticker) Stop()

Types

type Ticker

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

Ticker is a background ticker.

func New

func New(d time.Duration, f func() error) *Ticker

New starts a background ticker with a period specified by the duration argument, that will call the given function f on each tick. It is the caller's responsibility to ensure that the returned ticker is stopped via its Stop method, otherwise resources may leak.

func (*Ticker) Reset

func (t *Ticker) Reset()

Reset resets the ticker. This has no effect on a previously stopped ticker.

func (*Ticker) Stop

func (t *Ticker) Stop()

Stop stops the ticker, releasing any resources used by the ticker.