rate_limiter

Documentation

Index

• Constants
• type RateLimit
• type RateLimiter
  • func Disabled() RateLimiter
  • func New(rl RateLimit) RateLimiter
  • func Unlimited() RateLimiter
  • func (rl *RateLimiter) Acquire() (bool, int64)
  • func (rl *RateLimiter) Wait(ctx context.Context) error

Constants

const (
	// NOTE: Empty RateLimiter is unlimited one
	UNLIMITED = 0
	DISABLED  = -1
)

Types

type RateLimit

type RateLimit struct {
	Limit  int64
	Period time.Duration
}

type RateLimiter

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

NOTE: GCRA Rate Limiter https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm

func Disabled

func Disabled() RateLimiter

func New

func New(rl RateLimit) RateLimiter

func Unlimited

func Unlimited() RateLimiter

func (*RateLimiter) Acquire

func (rl *RateLimiter) Acquire() (bool, int64)

func (*RateLimiter) Wait

func (rl *RateLimiter) Wait(ctx context.Context) error