leakybucket

Documentation

Index

• func NewLeakyBucketLimiter(ctx context.Context, client redis.Cmdable, key string, duration time.Duration, ...) (ratelimit.Limiter, error)
• type LeakyBucketLimiter
  • func (r *LeakyBucketLimiter) Take(ctx context.Context) (bool, error)
  • func (r *LeakyBucketLimiter) Wait(ctx context.Context) (err error)
• type Option
  • func WithAntiDDos(antiDDoS bool) Option

Functions

func NewLeakyBucketLimiter

func NewLeakyBucketLimiter(ctx context.Context, client redis.Cmdable, key string, duration time.Duration,
	throughput int, opts ...Option) (ratelimit.Limiter, error)

Types

type LeakyBucketLimiter

type LeakyBucketLimiter struct {
	ratelimit.BaseRateLimiter

	/*
		If the traffic is too large, the limiter will request Redis frequently.
		To avoid this situation, the frequency of accessing Redis will be limited.
	*/
	AntiDDoS bool
	// contains filtered or unexported fields
}

func (*LeakyBucketLimiter) Take

func (r *LeakyBucketLimiter) Take(ctx context.Context) (bool, error)

func (*LeakyBucketLimiter) Wait

func (r *LeakyBucketLimiter) Wait(ctx context.Context) (err error)

wait until take a token or timeout

type Option

type Option func(*LeakyBucketLimiter)

func WithAntiDDos

func WithAntiDDos(antiDDoS bool) Option