ticker

Documentation

Index

• type Ticker
  • func New(interval time.Duration) *Ticker
  • func (t *Ticker) Stop()

Types

type Ticker

type Ticker struct {
	C <-chan int
	// contains filtered or unexported fields
}

Ticker holds a channel that delivers ticks of a clock at intervals. The ticks are aligned to interval boundaries.

func New

func New(interval time.Duration) *Ticker

New returns a new Ticker containing a channel that will send the time with a period specified by the duration argument. It adjusts the intervals or drops ticks to make up for slow receivers. The duration must be greater than zero; if not, New will panic. Stop the Ticker to release associated resources.

func (*Ticker) Stop

func (t *Ticker) Stop()

Stop turns off a Ticker. After Stop, no more ticks will be sent. Stop does not close the channel, to prevent a read from the channel succeeding incorrectly.