RateControl (Jetty :: Project 9.4.56.v20240826 API)

All Known Implementing Classes:

WindowRateControl
```
public interface RateControl
```
Controls rate of events via onEvent(Object).

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface RateControl.Factory
Factory to create RateControl instances.

Field Summary

Fields
Modifier and Type Field Description

static RateControl NO_RATE_CONTROL

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`onEvent(java.lang.Object event)`	Applications should call this method when they want to signal an event that is subject to rate control.

- Field Detail
  - NO_RATE_CONTROL
```
static final RateControl NO_RATE_CONTROL
```
- Method Detail
  - onEvent
```
boolean onEvent(java.lang.Object event)
```
    Applications should call this method when they want to signal an event that is subject to rate control.
    
    Implementations should return true if the event does not exceed the desired rate, or false to signal that the event exceeded the desired rate.
    
    Parameters:
    
    event - the event subject to rate control.
    
    Returns:
    
    true IFF the rate is within limits