forked from quarkusio/quarkus
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
da5ef32
commit a325017
Showing
4 changed files
with
151 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
.../vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/TrafficShapingConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
package io.quarkus.vertx.http.runtime; | ||
|
||
import java.time.Duration; | ||
import java.util.Optional; | ||
|
||
import io.quarkus.runtime.annotations.ConfigGroup; | ||
import io.quarkus.runtime.annotations.ConfigItem; | ||
import io.quarkus.runtime.configuration.MemorySize; | ||
|
||
/** | ||
* 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. | ||
* <p> | ||
* 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. | ||
* <p> | ||
* 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. | ||
*/ | ||
@ConfigGroup | ||
public class TrafficShapingConfig { | ||
|
||
/** | ||
* Enables the traffic shaping. | ||
*/ | ||
@ConfigItem(defaultValue = "false") | ||
public boolean enabled; | ||
|
||
/** | ||
* Set bandwidth limit in bytes per second for inbound connections. | ||
* If not set, no limits are applied. | ||
*/ | ||
@ConfigItem | ||
public Optional<MemorySize> inboundGlobalBandwidth; | ||
|
||
/** | ||
* Set bandwidth limit in bytes per second for outbound connections. | ||
* If not set, no limits are applied. | ||
*/ | ||
@ConfigItem | ||
public Optional<MemorySize> outboundGlobalBandwidth; | ||
|
||
/** | ||
* Set the maximum delay to wait in case of traffic excess. | ||
* Default is 15s. Must be less than the HTTP timeout. | ||
*/ | ||
@ConfigItem | ||
public Optional<Duration> maxDelay; | ||
|
||
/** | ||
* 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. | ||
* <p> | ||
* If not default, it defaults to 1s. | ||
*/ | ||
@ConfigItem | ||
public Optional<Duration> checkInterval; | ||
|
||
/** | ||
* 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. | ||
*/ | ||
@ConfigItem | ||
public Optional<MemorySize> peakOutboundGlobalBandwidth; | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters