Network.Wai.RateLimit.Strategy

Exports functions which implement rate-limiting strategies.

Documentation

newtype Strategy

Represents rate limiting strategies.

Constructors

MkStrategy

Fields

• strategyOnRequest :: Request -> IO Bool

  strategyOnRequest request is a computation which determines whether the request should be allowed or not, based on the rate limiting strategy.

fixedWindow :: Backend key -> Second -> Integer -> (Request -> IO key) -> Strategy

fixedWindow seconds limit is a Strategy which limits the number of requests made by a client to limit within a window of seconds.

slidingWindow :: Backend key -> Second -> Integer -> (Request -> IO key) -> Strategy

slidingWindow seconds limit is a Strategy which limits the number of requests made by a client to limit within a sliding window of seconds. That is, for every successful request, the window is extended by seconds so that a "break" of seconds is required after limit-many requests have been made in a period during which the timeout has never been exceeded.