Skip to content

Commit 96b1659

Browse files
mzellhoDavideD
authored andcommitted
chore: add missing docs for maximum values of MemorySize based config values
1 parent 43698d4 commit 96b1659

File tree

7 files changed

+13
-11
lines changed

7 files changed

+13
-11
lines changed

core/runtime/src/main/java/io/quarkus/runtime/logging/LogRuntimeConfig.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ interface FileConfig {
224224

225225
interface RotationConfig {
226226
/**
227-
* The maximum log file size, after which a rotation is executed.
227+
* The maximum log file size, after which a rotation is executed, up to {@code Long.MAX_VALUE} bytes.
228228
* Note that the file is rotated <em>after</em> the log record is written.
229229
* Thus, this isn't a hard maximum on the file size; rather, it's a hard <em>minimum</em>
230230
* on the size of the file before it is rotated.
@@ -401,7 +401,8 @@ interface SyslogConfig {
401401
Optional<String> filter();
402402

403403
/**
404-
* The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message.
404+
* The maximum length, in bytes, of the message allowed to be sent, up to {@code Integer.MAX_VALUE} bytes. The length
405+
* includes the header and the message.
405406
* <p>
406407
* If not set, the default value is {@code 2048} when {@code sys-log-type} is {@code rfc5424} (which is the default)
407408
* and {@code 1024} when {@code sys-log-type} is {@code rfc3164}

extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ public interface KeycloakDevServicesConfig {
204204
Map<String, String> containerEnv();
205205

206206
/**
207-
* Memory limit for Keycloak container
207+
* Memory limit for Keycloak container, up to {@code Long.MAX_VALUE} bytes.
208208
* </p>
209209
* If not specified, 750MiB is the default memory limit.
210210
*/

extensions/resteasy-classic/rest-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ public interface RestClientsConfig {
279279
/**
280280
* Configures two different things:
281281
* <ul>
282-
* <li>The max HTTP chunk size</li>
282+
* <li>The max HTTP chunk size, up to {@code Integer.MAX_VALUE} bytes.</li>
283283
* <li>The size of the chunk to be read when an {@link InputStream} is being used as an input</li>
284284
* </ul>
285285
* <p>
@@ -616,7 +616,7 @@ default Optional<String> uriReload() {
616616
/**
617617
* Configures two different things:
618618
* <ul>
619-
* <li>The max HTTP chunk size</li>
619+
* <li>The max HTTP chunk size, up to {@code Integer.MAX_VALUE} bytes.</li>
620620
* <li>The size of the chunk to be read when an {@link InputStream} is being read and sent to the server</li>
621621
* </ul>
622622
* <p>

extensions/resteasy-classic/resteasy-common/runtime/src/main/java/io/quarkus/resteasy/common/runtime/ResteasyCommonConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface ResteasyCommonConfigGzip {
2424
boolean enabled();
2525

2626
/**
27-
* Maximum deflated file bytes size
27+
* Maximum deflated file bytes size, up to {@code Long.MAX_VALUE} bytes.
2828
* <p>
2929
* If the limit is exceeded, Resteasy will return Response
3030
* with status 413("Request Entity Too Large")

extensions/resteasy-reactive/rest-common/runtime/src/main/java/io/quarkus/resteasy/reactive/common/runtime/ResteasyReactiveConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public interface ResteasyReactiveConfig {
1313

1414
/**
1515
* The amount of memory that can be used to buffer input before switching to
16-
* blocking IO.
16+
* blocking IO, up to {@code Long.MAX_VALUE} bytes.
1717
*/
1818
@WithDefault("10k")
1919
MemorySize inputBufferSize();

extensions/undertow/runtime/src/main/java/io/quarkus/undertow/runtime/ServletRuntimeConfig.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
public interface ServletRuntimeConfig {
1414

1515
/**
16-
* The buffer size to use for Servlet. If this is not specified the default will depend on the amount
16+
* The buffer size to use for Servlet, up to {@code Integer.MAX_VALUE} bytes. If this is not specified the default will
17+
* depend on the amount
1718
* of available memory. If there is less than 64mb it will default to 512b heap buffer, less that 128mb
1819
* 1k direct buffer and otherwise 16k direct buffers.
1920
*

extensions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/TrafficShapingConfig.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ public interface TrafficShapingConfig {
3131
boolean enabled();
3232

3333
/**
34-
* Set bandwidth limit in bytes per second for inbound connections.
34+
* Set bandwidth limit in bytes per second for inbound connections, up to {@code Long.MAX_VALUE} bytes.
3535
* If not set, no limits are applied.
3636
*/
3737
Optional<MemorySize> inboundGlobalBandwidth();
3838

3939
/**
40-
* Set bandwidth limit in bytes per second for outbound connections.
40+
* Set bandwidth limit in bytes per second for outbound connections, up to {@code Long.MAX_VALUE} bytes.
4141
* If not set, no limits are applied.
4242
*/
4343
Optional<MemorySize> outboundGlobalBandwidth();
@@ -61,7 +61,7 @@ public interface TrafficShapingConfig {
6161

6262
/**
6363
* Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write
64-
* are suspended.
64+
* are suspended, up to {@code Long.MAX_VALUE} bytes.
6565
* The default value is 400 MB.
6666
*/
6767
Optional<MemorySize> peakOutboundGlobalBandwidth();

0 commit comments

Comments
 (0)