loop

Documentation

Index

• type Loop
  • func NewLoop() *Loop
  • func (l *Loop) Do(tf TaskFunc, opts ...TaskOptions)
  • func (l *Loop) DoAndWait(tf TaskFunc, opts ...TaskOptions) (interface{}, error)
  • func (l *Loop) Repeat(tf TaskFunc, opts ...TaskOptions)
  • func (l *Loop) Run(ctx context.Context) (context.Context, context.CancelFunc)
• type RepeatIntervalFunc
• type TaskFunc
• type TaskOption
• type TaskOptions
  • func ExponentialRepeatIntervalOnError(init time.Duration, factor float64) TaskOptions
  • func FixedRepeatInterval(interval time.Duration) TaskOptions

Types

type Loop

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

func NewLoop

func NewLoop() *Loop

func (*Loop) Do

func (l *Loop) Do(tf TaskFunc, opts ...TaskOptions)

func (*Loop) DoAndWait

func (l *Loop) DoAndWait(tf TaskFunc, opts ...TaskOptions) (interface{}, error)

func (*Loop) Repeat

func (l *Loop) Repeat(tf TaskFunc, opts ...TaskOptions)

func (*Loop) Run

func (l *Loop) Run(ctx context.Context) (context.Context, context.CancelFunc)

type RepeatIntervalFunc

type RepeatIntervalFunc func(result interface{}, err error) time.Duration

RepeatIntervalFunc is used when schedule repeated TaskFunc. it takes result and error of previous TaskFunc invocation and determine the delay of next TaskFunc invocation

type TaskFunc

type TaskFunc func(ctx context.Context, l *Loop) (ret interface{}, err error)

TaskFunc can be scheduled to Loop with TaskOptions

type TaskOption

type TaskOption struct {
	RepeatIntervalFunc RepeatIntervalFunc
}

type TaskOptions

type TaskOptions func(opt *TaskOption)

func ExponentialRepeatIntervalOnError

func ExponentialRepeatIntervalOnError(init time.Duration, factor float64) TaskOptions

ExponentialRepeatIntervalOnError returns a TaskOptions which set repeat interval to be exponentially increased if error is not nil. the repeat interval is reset to "init" if error is nil

func FixedRepeatInterval

func FixedRepeatInterval(interval time.Duration) TaskOptions

FixedRepeatInterval returns a TaskOptions which set repeat interval to be fixed duration