ticker

Documentation

Index

• type Ticker
  • func New(period time.Duration) *Ticker
  • func (ticker *Ticker) Pause()
  • func (ticker *Ticker) Poll()
  • func (ticker *Ticker) Resume()
  • func (ticker *Ticker) Stop()
  • func (ticker *Ticker) Tick(fn func(time.Time))

Types

type Ticker

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

func New

func New(period time.Duration) *Ticker

func (*Ticker) Pause

func (ticker *Ticker) Pause()

Pause pauses the ticker.

func (*Ticker) Poll

func (ticker *Ticker) Poll()

Poll polls the ticker. It blocks until the tick has been executed.

func (*Ticker) Resume

func (ticker *Ticker) Resume()

Resume resumes the ticker.

func (*Ticker) Stop

func (ticker *Ticker) Stop()

Stop stops the ticker.

func (*Ticker) Tick

func (ticker *Ticker) Tick(fn func(time.Time))

Tick calls the given callback at regular intervals or when the ticker is polled.