RateLimitExceededEvent
in package
implements
IEvent
Event fired when a request exceeds rate limit thresholds.
This event is triggered by the RateLimitFilter when a client (identified by IP address or other key) exceeds the configured rate limit for a route or API endpoint.
Use cases:
- Security monitoring and abuse detection
- Automatically block or throttle abusive IPs
- Alert administrators of potential DDoS attacks
- Track rate limit patterns and adjust thresholds
- Generate security reports for compliance
- Trigger CAPTCHA challenges for suspicious traffic
Table of Contents
Interfaces
- IEvent
- Core event interface for the Neuron event system.
Properties
Methods
- __construct() : mixed
- getName() : string
Properties
$attempts read-only
public
int
$attempts
$ip read-only
public
string
$ip
$limit read-only
public
int
$limit
$route read-only
public
string
$route
$window read-only
public
int
$window
Methods
__construct()
public
__construct(string $ip, string $route, int $limit, int $window, int $attempts) : mixed
Parameters
- $ip : string
-
Client IP address that exceeded the limit
- $route : string
-
Route or endpoint that was rate limited
- $limit : int
-
Maximum requests allowed
- $window : int
-
Time window in seconds
- $attempts : int
-
Number of requests made in the window
getName()
public
getName() : string