algorithm

Documentation

Overview

Package algorithm contains all rate limiting algorithms that define the Strategy interface

Package algorithm contains all rate limiting algorithms that define the Strategy interface

Index

• func New(algorithm string, client *redis.Client, now func() time.Time) (interfaces.Strategy, error)
• type FixedWindow
  • func (fw *FixedWindow) Run(req *interfaces.Request) (*interfaces.Result, error)
• type RollingWindow
  • func (rw *RollingWindow) Run(req *interfaces.Request) (*interfaces.Result, error)

Functions

func New

func New(algorithm string, client *redis.Client, now func() time.Time) (interfaces.Strategy, error)

New function instantiates a new usecase

Types

type FixedWindow

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

FixedWindow strategy

func (*FixedWindow) Run

func (fw *FixedWindow) Run(req *interfaces.Request) (*interfaces.Result, error)

Run function implements the fixed window rate limiter logic

type RollingWindow

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

RollingWindow strategy

func (*RollingWindow) Run

func (rw *RollingWindow) Run(req *interfaces.Request) (*interfaces.Result, error)

Run function implements the fixed window rate limiter logic