fixedwindow

Documentation

Overview

Package fixedwindow implements the Fixed Window rate limiting algorithm.

Time is partitioned into discrete fixed windows (e.g., every 1 minute). A counter is incremented for each incoming request and resets to zero at the boundary of a new window.

Index

• type Strategy
  • func New() *Strategy
  • func (s *Strategy) EvaluateMemory(now time.Time, state *algorithm.State, limit int64, window time.Duration) algorithm.Result
  • func (s *Strategy) Name() string
  • func (s *Strategy) RedisScript() string

Types

type Strategy

type Strategy struct{}

Strategy implements the algorithm.Algorithm interface for Fixed Window.

func New

func New() *Strategy

New creates a new instance of the Fixed Window algorithm strategy.

func (*Strategy) EvaluateMemory

func (s *Strategy) EvaluateMemory(now time.Time, state *algorithm.State, limit int64, window time.Duration) algorithm.Result

EvaluateMemory evaluates the fixed window rate limit state synchronously in RAM.

func (*Strategy) Name

func (s *Strategy) Name() string

Name returns the unique identifier of the algorithm strategy.

func (*Strategy) RedisScript

func (s *Strategy) RedisScript() string

RedisScript returns the high-performance atomic Lua script utilizing Redis INCR.