ticker

Documentation

Index

• Variables
• type Config
• type Ticker
  • func New(config *Config) *Ticker
  • func (tk *Ticker) Stop() error

Variables

var ErrAlreadyStopped = errors.New("Already stopped")

ErrAlreadyStopped is returned if this service was already stopped and Stop() is called again

Types

type Config

type Config struct {
	Clock    clock.Clock
	Interval time.Duration
	Callback func()
}

Config defines the necessary information and dependencies to instantiate a Ticker

type Ticker

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

Ticker represents a periodic timer that invokes a callback

func New

func New(config *Config) *Ticker

New builds a ticker that will call the given callback function periodically

func (*Ticker) Stop

func (tk *Ticker) Stop() error

Stop stops the timer and releases the goroutine running it.