throttle

Documentation

Index

• Variables
• type Options
  • func NewOptions() *Options
  • func (o *Options) Valid() error
• type Throttler
  • func New(opts *Options) *Throttler
  • func (t *Throttler) Do(ctx context.Context, fn func(ctx context.Context) error) error

Variables

var (
	ErrTimeout          = errors.New("throttle: timeout")
	ErrCapacityExceeded = errors.New("throttle: capacity exceeded")
)

Types

type Options

type Options struct {
	BacklogLimit   int
	BacklogTimeout time.Duration
	Limit          int
}

func NewOptions

func NewOptions() *Options

func (*Options) Valid

func (o *Options) Valid() error

type Throttler

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

func New

func New(opts *Options) *Throttler

func (*Throttler) Do

func (t *Throttler) Do(ctx context.Context, fn func(ctx context.Context) error) error