raterun

Documentation

Index

• func New(fn RunFunction, rates []Rate) (*rrInstance, error)
• func NewRatedRunnerStage(t *testing.T) (*RatedRunnerStage, *RatedRunnerStage, *RatedRunnerStage)
• type Rate
• type RatedRunnerStage
• type RunFunction
• type Runner

Functions

func New

func New(fn RunFunction, rates []Rate) (*rrInstance, error)

New creates a new runner which varies in time according to given rates

func NewRatedRunnerStage

func NewRatedRunnerStage(t *testing.T) (*RatedRunnerStage, *RatedRunnerStage, *RatedRunnerStage)

Types

type Rate

type Rate struct {
	Start time.Duration // when to start this rate
	Rate  time.Duration // run in amount of Duration
}

type RatedRunnerStage

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

type RunFunction

type RunFunction func(rate time.Duration, t time.Time)

RunFunction function to be executed at specified rate

type Runner

type Runner interface {
	// Terminate cancels scheduling for the next run
	Terminate()
	// RestartRate resets function calling back to first defined rate
	RestartRate()
	// run starts running the function at rates provided to the constructor
	Run()
}