onceevery

Documentation

Index

• type OnceEvery
  • func New(d time.Duration) *OnceEvery
  • func (o *OnceEvery) Do(f func())
  • func (o *OnceEvery) Stop()

Types

type OnceEvery

type OnceEvery struct {
	Interval time.Duration
	// contains filtered or unexported fields
}

OnceEvery is an object that will perform exactly one action every given interval.

func New

func New(d time.Duration) *OnceEvery

NewOnceEvery creates a new OnceEvery struct

func (*OnceEvery) Do

func (o *OnceEvery) Do(f func())

Do calls the function f if and only if Do hits the given periodic interval. In other words Do can be called multiple times during the interval but it gets called only once if it hits the interval tick. So if the interval is 10 seconds, and a total of 100 calls are made during this period, f will be called it every 10 seconds.

func (*OnceEvery) Stop

func (o *OnceEvery) Stop()

Stop stops the ticker. No other call made with Do will be called anymore.