ratelimiter

README

ratelimiter

-- import "github.com/Clever/sphinx/ratelimiter"

Usage

var NilStatus = Status{
	Capacity:  1,
	Reset:     time.Now(),
	Remaining: 1,
	Name:      "Unknown",
}

NilStatus for when acting as passive proxy

type RateLimiter

type RateLimiter interface {
	Add(request common.Request) ([]Status, error)
}

RateLimiter rate limits requests based on given configuration and limits.

func New

func New(config config.Config) (RateLimiter, error)

New returns a new RateLimiter based on the given configuration.

type Status

type Status struct {
	Capacity  uint
	Reset     time.Time
	Remaining uint
	Name      string
}

Status contains the status of a limit.

Documentation

Index

• Variables
• type RateLimiter
  • func New(config config.Config) (RateLimiter, error)
• type Status

Variables

var NilStatus = Status{
	Capacity:  1,
	Reset:     time.Now(),
	Remaining: 1,
	Name:      "Unknown",
}

NilStatus for when acting as passive proxy

Types

type RateLimiter

type RateLimiter interface {
	Add(request common.Request) ([]Status, error)
}

RateLimiter rate limits requests based on given configuration and limits.

func New

func New(config config.Config) (RateLimiter, error)

New returns a new RateLimiter based on the given configuration.

type Status

type Status struct {
	Capacity  uint
	Reset     time.Time
	Remaining uint
	Name      string
}

Status contains the status of a limit.