rate_limit

Documentation

Index

• Constants
• Variables
• type Enpoints
• type InternalRateLimitClient
• type InternalRateStore
  • func (s *InternalRateStore) Get(route interface{}, endpointName string, methodName string) (*Rate, error)
  • func (s *InternalRateStore) GetAppRate(route interface{}) (*Rate, error)
  • func (s *InternalRateStore) IsRateLimited(rate *Rate) (bool, error)
  • func (s *InternalRateStore) Set(route interface{}, endpointName string, methodName string, ...) error
  • func (s *InternalRateStore) SetAppRate(route interface{}, headers *http.Header) error
  • func (s *InternalRateStore) UpdateInternalRateCount(old *Rate, new *Rate)
• type Methods
• type Rate
  • func ParseHeaders(headers *http.Header, limitHeader string, countHeader string) (*Rate, error)
• type RateLimit
  • func NewInternalRateLimit() *RateLimit
  • func (r *RateLimit) Get(route interface{}, endpointName string, methodName string) (*Rate, error)
  • func (r *RateLimit) GetAppRate(route interface{}) (*Rate, error)
  • func (r *RateLimit) IsRateLimited(rate *Rate) (bool, error)
  • func (r *RateLimit) Set(route interface{}, endpointName string, methodName string, ...) error
  • func (r *RateLimit) SetAppRate(route interface{}, headers *http.Header) error
• type RateLimitStoreType
• type RateTiming
• type Store

Constants

const (
	AppRateLimitHeader         = "X-App-Rate-Limit"
	AppRateLimitCountHeader    = "X-App-Rate-Limit-Count"
	MethodRateLimitHeader      = "X-Method-Rate-Limit"
	MethodRateLimitCountHeader = "X-Method-Rate-Limit-Count"
)

Variables

var (
	ErrRateLimitingIsDisabled = errors.New("Rate limiting is disabled")
)

Types

type Enpoints

type Enpoints struct {
	Endpoints map[string]*Methods
	AppRate   *Rate
}

type InternalRateLimitClient

type InternalRateLimitClient interface {
	Get(route interface{}, endpointName string, methodName string) (*Rate, error)
	GetAppRate(route interface{}) (*Rate, error)
	Set(route interface{}, endpointName string, methodName string, headers *http.Header) error
	SetAppRate(route interface{}, headers *http.Header) error
	ParseHeaders(headers *http.Header, limitHeader string, countHeader string) (*Rate, error)
	IsRateLimited(rate *Rate) (bool, error)
}

type InternalRateStore

type InternalRateStore struct {
	Route map[interface{}]*Enpoints
	// contains filtered or unexported fields
}

func (*InternalRateStore) Get

func (s *InternalRateStore) Get(route interface{}, endpointName string, methodName string) (*Rate, error)

func (*InternalRateStore) GetAppRate

func (s *InternalRateStore) GetAppRate(route interface{}) (*Rate, error)

func (*InternalRateStore) IsRateLimited

func (s *InternalRateStore) IsRateLimited(rate *Rate) (bool, error)

func (*InternalRateStore) Set

func (s *InternalRateStore) Set(route interface{}, endpointName string, methodName string, headers *http.Header) error

func (*InternalRateStore) SetAppRate

func (s *InternalRateStore) SetAppRate(route interface{}, headers *http.Header) error

func (*InternalRateStore) UpdateInternalRateCount

func (s *InternalRateStore) UpdateInternalRateCount(old *Rate, new *Rate)

type Methods

type Methods struct {
	Methods map[string]*Rate
}

type Rate

type Rate struct {
	Seconds RateTiming
	Minutes RateTiming
}

func ParseHeaders

func ParseHeaders(headers *http.Header, limitHeader string, countHeader string) (*Rate, error)

type RateLimit

type RateLimit struct {
	Enabled   bool
	StoreType RateLimitStoreType
	// contains filtered or unexported fields
}

func NewInternalRateLimit

func NewInternalRateLimit() *RateLimit

func (*RateLimit) Get

func (r *RateLimit) Get(route interface{}, endpointName string, methodName string) (*Rate, error)

func (*RateLimit) GetAppRate

func (r *RateLimit) GetAppRate(route interface{}) (*Rate, error)

func (*RateLimit) IsRateLimited

func (r *RateLimit) IsRateLimited(rate *Rate) (bool, error)

func (*RateLimit) Set

func (r *RateLimit) Set(route interface{}, endpointName string, methodName string, headers *http.Header) error

func (*RateLimit) SetAppRate

func (r *RateLimit) SetAppRate(route interface{}, headers *http.Header) error

type RateLimitStoreType

type RateLimitStoreType string

const (
	InternalRateLimiter RateLimitStoreType = "Internal"
	RedisRateLimiter    RateLimitStoreType = "Redis"
)

type RateTiming

type RateTiming struct {
	// The amount in seconds the rate limit should reset.
	Time int
	// Maximum amount of requests in n seconds.
	Limit int
	// Current count of requests made in n seconds.
	Count int

	Expire time.Time
	Access time.Time
}

type Store

type Store interface {
	Get(route interface{}, endpointName string, methodName string) (*Rate, error)
	GetAppRate(route interface{}) (*Rate, error)
	Set(route interface{}, endpointName string, methodName string, headers *http.Header) error
	SetAppRate(route interface{}, headers *http.Header) error
	IsRateLimited(rate *Rate) (bool, error)
}