throttle

Documentation

Index

• type Option
  • func SetQueueLen(n uint64) Option
  • func SetWorkerNum(n uint64) Option
• type Throttler
  • func New(tps uint64, opts ...Option) *Throttler
  • func (t *Throttler) Allow() bool
  • func (t *Throttler) Start(ctx context.Context)

Types

type Option

type Option func(*Throttler)

Option is an option

func SetQueueLen

func SetQueueLen(n uint64) Option

SetQueueLen sets queue length

func SetWorkerNum

func SetWorkerNum(n uint64) Option

SetWorkerNum sets worker number

type Throttler

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

Throttler struct

func New

func New(tps uint64, opts ...Option) *Throttler

New creates an instance of throttler

func (*Throttler) Allow

func (t *Throttler) Allow() bool

Allow returns true if action is not throttled, returns false if is throttled.

func (*Throttler) Start

func (t *Throttler) Start(ctx context.Context)

Start starts the throttler