Increment a cache entry using a composed key derived from the zone and user key.

This is typically used in fixed-window rate limiters to track the number of requests within a time period. The function creates a composite cache key from the throttle name, algorithm type, IP zone, and user key, then increments the stored counter value.

The stored type must be JSON-serializable and support numeric operations.

Examples

newCount <- incStoreWithZone cache "api-throttle" "zone-a" "user123" 3600
print newCount  -- Prints the incremented counter value

Read a cache entry using a composed key.

Useful for debugging or non-mutating cache inspection. The function constructs the appropriate cache key from the provided components and retrieves the stored value if it exists.

Examples

maybeValue <- readCacheWithZone cache "throttle1" "zone1" "user456"
case maybeValue of
  Just val -> print val
  Nothing  -> putStrLn "No entry found"

Write a value into the cache using a zone-aware key.

Typically used for manual updates, testing, or initializing state. The function creates a composite key and stores the provided value with the specified expiration time.

Examples

writeCacheWithZone cache "throttle1" "zone1" "user789" (42 :: Int) 1800
putStrLn "Value written to cache"

Delete an entry from the cache using a zone-aware key.

Can be used to forcibly reset rate limiter state or clean up expired entries manually. The function constructs the appropriate cache key and removes the corresponding entry.

Examples

deleteCacheWithZone cache "throttle1" "zone1" "user123"
putStrLn "Cache entry deleted"

Attempt to allow a request under a Fixed Window rate-limiting strategy.

This increments the counter for the composed key built from the given zone and user key. The request is allowed if the resulting count does not exceed the limit for the given period.

The function takes a FixedWindow cache, throttle name, IP zone, user key, request limit, and time period. It returns True if the request should be allowed, False otherwise.

Examples

allowed <- allowFixedWindowRequest myCache "throttle1" "zone1" "userA" 10 60
if allowed
  then putStrLn "Request allowed"
  else putStrLn "Request denied - rate limit exceeded"