Package io.quarkus.vertx.http.runtime

Class TrafficShapingConfig

java.lang.Object

io.quarkus.vertx.http.runtime.TrafficShapingConfig

public class TrafficShapingConfig
extends Object

Configure the global traffic shaping functionality. It allows you to limit the bandwidth across all channels, regardless of the number of open channels. This can be useful when you want to control the overall network traffic to prevent congestion or prioritize certain types of traffic.

The traffic shaping allows you to configure various parameters, such as write and read limitations (in bytes per second), check interval (the delay between two computations of the bandwidth), and maximum time to wait. The check interval represents the period at which the traffic is computed, and a higher interval may result in less precise traffic shaping. It is recommended to set a positive value for the check interval, even if it is high, to ensure traffic shaping without accounting. A suggested value is something close to 5 or 10 minutes.

The `outbound-global-bandwidth` and `inbound-global-bandwidth` parameters represent the maximum number of bytes per second for write and read operations, respectively. Additionally, you can set the maximum time to wait, which specifies an upper bound for time shaping. By default, it is set to 15 seconds.

Field Summary

Fields

Modifier and Type	Field	Description
Optional<Duration>	checkInterval	Set the delay between two computations of performances for channels.
boolean	enabled	Enables the traffic shaping.
Optional<MemorySize>	inboundGlobalBandwidth	Set bandwidth limit in bytes per second for inbound connections.
Optional<Duration>	maxDelay	Set the maximum delay to wait in case of traffic excess.
Optional<MemorySize>	outboundGlobalBandwidth	Set bandwidth limit in bytes per second for outbound connections.
Optional<MemorySize>	peakOutboundGlobalBandwidth	Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended.

Constructor Summary

Constructors

Constructor	Description
TrafficShapingConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enabled

@ConfigItem(defaultValue="false")
public boolean enabled

Enables the traffic shaping.

inboundGlobalBandwidth

@ConfigItem
public Optional<MemorySize> inboundGlobalBandwidth

Set bandwidth limit in bytes per second for inbound connections. If not set, no limits are applied.

outboundGlobalBandwidth

@ConfigItem
public Optional<MemorySize> outboundGlobalBandwidth

Set bandwidth limit in bytes per second for outbound connections. If not set, no limits are applied.

maxDelay

@ConfigItem
public Optional<Duration> maxDelay

Set the maximum delay to wait in case of traffic excess. Default is 15s. Must be less than the HTTP timeout.

checkInterval

@ConfigItem
public Optional<Duration> checkInterval

Set the delay between two computations of performances for channels. If set to 0, no stats are computed. Despite 0 is accepted (no accounting), it is recommended to set a positive value for the check interval, even if it is high since the precision of the traffic shaping depends on the period where the traffic is computed. In this case, a suggested value is something close to 5 or 10 minutes.

If not default, it defaults to 1s.

peakOutboundGlobalBandwidth

@ConfigItem
public Optional<MemorySize> peakOutboundGlobalBandwidth

Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended. The default value is 400 MB.

Constructor Detail

TrafficShapingConfig

public TrafficShapingConfig()