Top Description Inners Fields Methods
org.eclipse.jetty.http2

public Interface RateControl

Known Direct Implementers
org.eclipse.jetty.http2.WindowRateControl
Imports
org.eclipse.jetty.io.EndPoint
Controls rate of events via onEvent(Object).

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
RateControl.Factory

Factory to create RateControl instances.

Field Summary

Modifier and TypeField and Description
public static final RateControl
NO_RATE_CONTROL

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true IFF the rate is within limits
onEvent(Object
the event subject to rate control.
event)

Applications should call this method when they want to signal an event that is subject to rate control.

Field Detail

NO_RATE_CONTROLback to summary
public static final RateControl NO_RATE_CONTROL

Method Detail

onEventback to summary
public boolean onEvent(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:Object

the event subject to rate control.

Returns:boolean

true IFF the rate is within limits

org.eclipse.jetty.http2 back to summary

public Interface RateControl.Factory

Known Direct Implementers
org.eclipse.jetty.http2.WindowRateControl.Factory
Factory to create RateControl instances.

Method Summary

Modifier and TypeMethod and Description
public default RateControl
newRateControl(EndPoint
the EndPoint for which the RateControl is created
endPoint)

Returns: a new RateControl instance for the given EndPoint

Method Detail

newRateControlback to summary
public default RateControl newRateControl(EndPoint endPoint)
Parameters
endPoint:EndPoint

the EndPoint for which the RateControl is created

Returns:RateControl

a new RateControl instance for the given EndPoint