loop

Documentation

Overview

Package loop 提供了一个循环执行某个方法的功能，可以自定义执行时间等。 用法： l := loop.New() l.Do(方法)

Index

• type Loop
  • func New(options ...Option) *Loop
  • func (l *Loop) CalculateInterval(loopedTimes uint64) time.Duration
  • func (l *Loop) Do(f func() (bool, error)) error
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithDeclineLimit(t time.Duration) Option
  • func WithDeclineRatio(n float64) Option
  • func WithInterval(t time.Duration) Option
  • func WithMaxTimes(n uint64) Option

Types

type Loop

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

Loop 定义循环执行任务的对象.

func New

func New(options ...Option) *Loop

New 创建一个新的 Loop 实例.

func (*Loop) CalculateInterval

func (l *Loop) CalculateInterval(loopedTimes uint64) time.Duration

CalculateInterval 传入当前循环次数，计算间隔时间

func (*Loop) Do

func (l *Loop) Do(f func() (bool, error)) error

Do 循环的执行一个方法 这个被循环执行的方法有两个返回值，第一个返回值控制是否需要退出循环，第二为任务执行的错误信息.

type Option

type Option func(*Loop)

Option 定义 Loop 对象的参数配置选项.

func WithContext

func WithContext(ctx context.Context) Option

WithContext set the context to cancel loop

func WithDeclineLimit

func WithDeclineLimit(t time.Duration) Option

WithDeclineLimit 设置衰退延迟的最大值，默认不限制最大值.

func WithDeclineRatio

func WithDeclineRatio(n float64) Option

WithDeclineRatio 设置衰退延迟的比例，默认是 1.

func WithInterval

func WithInterval(t time.Duration) Option

WithInterval 设置每次循环的间隔时间.

func WithMaxTimes

func WithMaxTimes(n uint64) Option

WithMaxTimes 设置循环的最大次数.