ratelimit

Documentation

Index

• type HTTPDoer
• type Limiter
  • func NewLimiter(maxTokens, refillRate float64) *Limiter
  • func (l *Limiter) TryAcquire() bool
  • func (l *Limiter) Wait(ctx context.Context) error
• type RateLimitedHTTPClient
  • func NewRateLimitedHTTPClient(inner HTTPDoer, limiter *Limiter) *RateLimitedHTTPClient
  • func (c *RateLimitedHTTPClient) Do(req *http.Request) (*http.Response, error)

Types

type HTTPDoer

type HTTPDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPDoer is an interface for making HTTP requests. Both *http.Client and *RateLimitedHTTPClient satisfy this interface.

type Limiter

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

Limiter implements a token bucket rate limiter. Thread-safe for concurrent use.

func NewLimiter

func NewLimiter(maxTokens, refillRate float64) *Limiter

NewLimiter creates a rate limiter with specified capacity and refill rate.

Example: NewLimiter(100, 10.0) creates a limiter with: - 100 token capacity - 10 tokens per second refill rate - Allows bursts up to 100 requests - Steady state: 10 requests/sec

func (*Limiter) TryAcquire

func (l *Limiter) TryAcquire() bool

TryAcquire attempts to acquire a token without blocking. Returns true if token acquired, false if none available.

func (*Limiter) Wait

func (l *Limiter) Wait(ctx context.Context) error

Wait blocks until a token is available, respecting context cancellation. Returns context.Canceled or context.DeadlineExceeded if context ends.

type RateLimitedHTTPClient

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

RateLimitedHTTPClient wraps an HTTPDoer with token bucket rate limiting.

func NewRateLimitedHTTPClient

func NewRateLimitedHTTPClient(inner HTTPDoer, limiter *Limiter) *RateLimitedHTTPClient

NewRateLimitedHTTPClient wraps an existing HTTPDoer with rate limiting. If limiter is nil, requests pass through without rate limiting.

func (*RateLimitedHTTPClient) Do

func (c *RateLimitedHTTPClient) Do(req *http.Request) (*http.Response, error)

Do executes an HTTP request, blocking until a rate limit token is available.