ticker

Documentation

Index

• type ExitError
  • func (e ExitError) Error() string
• type Option
  • func WithExecAtBegin(exec bool) Option
• type Task
• type Ticker
  • func New(interval time.Duration, task Task, opts ...Option) *Ticker
  • func (d *Ticker) Close()
  • func (d *Ticker) Run() error

Types

type ExitError

type ExitError struct {
	Message string
}

func (ExitError) Error

func (e ExitError) Error() string

type Option

type Option func(d *Ticker)

func WithExecAtBegin

func WithExecAtBegin(exec bool) Option

type Task

type Task func() (finished bool, err error)

type Ticker

type Ticker struct {
	Name     string
	Interval time.Duration
	Task     func() (stop bool, err error)

	ExecAtBegin bool
	// contains filtered or unexported fields
}

func New

func New(interval time.Duration, task Task, opts ...Option) *Ticker

func (*Ticker) Close

func (d *Ticker) Close()

func (*Ticker) Run

func (d *Ticker) Run() error