ratelimiter

Documentation

Index

• type GlobalRateLimiter
  • func NewGlobalRateLimiter(limit, freq int) *GlobalRateLimiter
  • func (rl *GlobalRateLimiter) Wait() (bool, time.Duration)
• type RateLimitTransport
  • func (rlt *RateLimitTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type RateLimiter
  • func NewRateLimiter(getLimit, postPutDeleteLimit, getFreq, postPutDeleteFreq int) *RateLimiter
  • func (rl *RateLimiter) Wait(method string) (bool, time.Duration)

Types

type GlobalRateLimiter

type GlobalRateLimiter struct {
	Limit int // Maximum number of requests allowed
	Freq  int // Frequency window in seconds
	// contains filtered or unexported fields
}

GlobalRateLimiter enforces global rate limits across all requests.

func NewGlobalRateLimiter

func NewGlobalRateLimiter(limit, freq int) *GlobalRateLimiter

NewGlobalRateLimiter creates a new instance of a global rate limiter.

func (*GlobalRateLimiter) Wait

func (rl *GlobalRateLimiter) Wait() (bool, time.Duration)

Wait checks if the rate limit is exceeded and calculates the wait time.

type RateLimitTransport

type RateLimitTransport struct {
	Base            http.RoundTripper
	Limiter         *GlobalRateLimiter
	WaitFunc        func() (bool, time.Duration) // Wait function reference
	Logger          logger.Logger
	AdditionalDelay time.Duration // Optional constant delay
}

RateLimitTransport wraps the HTTP transport to apply rate limiting.

func (*RateLimitTransport) RoundTrip

func (rlt *RateLimitTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements the http.RoundTripper interface for rate limiting.

type RateLimiter

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

func NewRateLimiter

func NewRateLimiter(getLimit, postPutDeleteLimit, getFreq, postPutDeleteFreq int) *RateLimiter

func (*RateLimiter) Wait

func (rl *RateLimiter) Wait(method string) (bool, time.Duration)