package ratelimit

import "github.com/go-kit/kit/ratelimit"

Index ¶

• Variables
• func NewDelayingLimiter(limit Waiter) endpoint.Middleware
• func NewErroringLimiter(limit Allower) endpoint.Middleware
• func NewTokenBucketLimiter(tb *ratelimit.Bucket) endpoint.Middleware
• func NewTokenBucketThrottler(tb *ratelimit.Bucket, _ func(time.Duration)) endpoint.Middleware
• type Allower
• func NewAllower(tb *ratelimit.Bucket) Allower
• type AllowerFunc
• func (f AllowerFunc) Allow() bool
• type Waiter
• func NewWaiter(tb *ratelimit.Bucket) Waiter
• type WaiterFunc
• func (f WaiterFunc) Wait(ctx context.Context) error

Variables ¶

var ErrLimited = errors.New("rate limit exceeded")

ErrLimited is returned in the request path when the rate limiter is triggered and the request is rejected.

Functions ¶

func NewDelayingLimiter ¶

func NewDelayingLimiter(limit Waiter) endpoint.Middleware

NewDelayingLimiter returns an endpoint.Middleware that acts as a request throttler. Requests that would exceed the maximum request rate are delayed via the Waiter function

func NewErroringLimiter ¶

func NewErroringLimiter(limit Allower) endpoint.Middleware

NewErroringLimiter returns an endpoint.Middleware that acts as a rate limiter. Requests that would exceed the maximum request rate are simply rejected with an error.

func NewTokenBucketLimiter ¶

func NewTokenBucketLimiter(tb *ratelimit.Bucket) endpoint.Middleware

NewTokenBucketLimiter returns an endpoint.Middleware that acts as a rate limiter based on a token-bucket algorithm. Requests that would exceed the maximum request rate are simply rejected with an error.

func NewTokenBucketThrottler ¶

func NewTokenBucketThrottler(tb *ratelimit.Bucket, _ func(time.Duration)) endpoint.Middleware

NewTokenBucketThrottler returns an endpoint.Middleware that acts as a request throttler based on a token-bucket algorithm. Requests that would exceed the maximum request rate are delayed. The parameterized function "_" is kept for backwards-compatiblity of the API, but it is no longer used for anything. You may pass it nil.

Types ¶

type Allower ¶

type Allower interface {
	Allow() bool
}

Allower dictates whether or not a request is acceptable to run. The Limiter from "golang.org/x/time/rate" already implements this interface, one is able to use that in NewErroringLimiter without any modifications.

func NewAllower ¶

func NewAllower(tb *ratelimit.Bucket) Allower

NewAllower turns an existing ratelimit.Bucket into an API-compatible form

type AllowerFunc ¶

type AllowerFunc func() bool

AllowerFunc is an adapter that lets a function operate as if it implements Allower

func (AllowerFunc) Allow ¶

func (f AllowerFunc) Allow() bool

Allow makes the adapter implement Allower

type Waiter ¶

type Waiter interface {
	Wait(ctx context.Context) error
}

Waiter dictates how long a request must be delayed. The Limiter from "golang.org/x/time/rate" already implements this interface, one is able to use that in NewDelayingLimiter without any modifications.

func NewWaiter ¶

func NewWaiter(tb *ratelimit.Bucket) Waiter

NewWaiter turns an existing ratelimit.Bucket into an API-compatible form

type WaiterFunc ¶

type WaiterFunc func(ctx context.Context) error

WaiterFunc is an adapter that lets a function operate as if it implements Waiter

func (WaiterFunc) Wait ¶

func (f WaiterFunc) Wait(ctx context.Context) error

Wait makes the adapter implement Waiter

Source Files ¶

token_bucket.go