flowctrl

Documentation

Index

• type RateLimiter
  • func NewRateLimiter(qps, burst int64) RateLimiter

Types

type RateLimiter

type RateLimiter interface {
	// TryAccept returns true if a token is taken immediately. Otherwise,
	// it returns false.
	TryAccept() bool

	// Accept will wait and not return unless a token becomes available.
	Accept()

	// QPS returns QPS of this rate limiter
	QPS() int64

	// Burst returns the burst of this rate limiter
	Burst() int64
}

func NewRateLimiter

func NewRateLimiter(qps, burst int64) RateLimiter