(james-project) 01/02: JAMES-4093 TrafficShapingConfiguration: change `checkInterval` and `maxDelays` default values to Netty ones

[btellier]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit fcb1d06fd6460ac025ed8f36362d0c9ab73810ee
Author: Quan Tran <hqt...@linagora.com>
AuthorDate: Tue Dec 17 14:39:48 2024 +0700

    JAMES-4093 TrafficShapingConfiguration: change `checkInterval` and 
`maxDelays` default values to Netty ones
    
    The unit is millisecond, not second.
    checkInterval 30ms -> likely not performance wise.
    maxDelays 30ms -> after maximum 30ms, bandwidth throttling ends -> almost 
no traffic shaping applied with the old default value (TESTED).
---
 docs/modules/servers/partials/configure/imap.adoc                  | 4 ++--
 .../apache/james/imapserver/netty/TrafficShapingConfiguration.java | 7 +++++--
 .../src/test/resources/imapserver.xml                              | 4 ++--
 src/site/xdoc/server/config-imap4.xml                              | 4 ++--
 4 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/docs/modules/servers/partials/configure/imap.adoc 
b/docs/modules/servers/partials/configure/imap.adoc
index 1965f17700..0fe943cb8a 100644
--- a/docs/modules/servers/partials/configure/imap.adoc
+++ b/docs/modules/servers/partials/configure/imap.adoc
@@ -170,8 +170,8 @@ Example:
         <trafficShaping>
             <writeTrafficPerSecond>0</writeTrafficPerSecond>
             <readTrafficPerSecond>0</readTrafficPerSecond>
-            <checkInterval>1</checkInterval>
-            <maxDelays>30</maxDelays>
+            <checkInterval>1000</checkInterval>
+            <maxDelays>15000</maxDelays>
         </trafficShaping>
     </imapserver>
 ....
diff --git 
a/server/protocols/protocols-imap4/src/main/java/org/apache/james/imapserver/netty/TrafficShapingConfiguration.java
 
b/server/protocols/protocols-imap4/src/main/java/org/apache/james/imapserver/netty/TrafficShapingConfiguration.java
index 97b35913c5..b2064dcb80 100644
--- 
a/server/protocols/protocols-imap4/src/main/java/org/apache/james/imapserver/netty/TrafficShapingConfiguration.java
+++ 
b/server/protocols/protocols-imap4/src/main/java/org/apache/james/imapserver/netty/TrafficShapingConfiguration.java
@@ -19,6 +19,9 @@
 
 package org.apache.james.imapserver.netty;
 
+import static 
io.netty.handler.traffic.AbstractTrafficShapingHandler.DEFAULT_CHECK_INTERVAL;
+import static 
io.netty.handler.traffic.AbstractTrafficShapingHandler.DEFAULT_MAX_TIME;
+
 import org.apache.commons.configuration2.Configuration;
 
 import io.netty.handler.traffic.ChannelTrafficShapingHandler;
@@ -28,8 +31,8 @@ public record TrafficShapingConfiguration(long writeLimit, 
long readLimit, long
         return new TrafficShapingConfiguration(
             configuration.getLong("writeTrafficPerSecond", 0),
             configuration.getLong("readTrafficPerSecond", 0),
-            configuration.getLong("checkInterval", 30),
-            configuration.getLong("maxDelays", 30));
+            configuration.getLong("checkInterval", DEFAULT_CHECK_INTERVAL),
+            configuration.getLong("maxDelays", DEFAULT_MAX_TIME));
     }
 
     public ChannelTrafficShapingHandler newHandler() {
diff --git 
a/server/protocols/webadmin-integration-test/memory-webadmin-integration-test/src/test/resources/imapserver.xml
 
b/server/protocols/webadmin-integration-test/memory-webadmin-integration-test/src/test/resources/imapserver.xml
index 8f376f58f5..f30afe0b24 100644
--- 
a/server/protocols/webadmin-integration-test/memory-webadmin-integration-test/src/test/resources/imapserver.xml
+++ 
b/server/protocols/webadmin-integration-test/memory-webadmin-integration-test/src/test/resources/imapserver.xml
@@ -40,8 +40,8 @@ under the License.
         <trafficShaping>
             <writeTrafficPerSecond>0</writeTrafficPerSecond>
             <readTrafficPerSecond>0</readTrafficPerSecond>
-            <checkInterval>1</checkInterval>
-            <maxDelays>30</maxDelays>
+            <checkInterval>1000</checkInterval>
+            <maxDelays>15000</maxDelays>
         </trafficShaping>
     </imapserver>
     <imapserver enabled="true">
diff --git a/src/site/xdoc/server/config-imap4.xml 
b/src/site/xdoc/server/config-imap4.xml
index b925d8fb5c..b935701f46 100644
--- a/src/site/xdoc/server/config-imap4.xml
+++ b/src/site/xdoc/server/config-imap4.xml
@@ -163,8 +163,8 @@
         &lt;trafficShaping&gt;
             &lt;writeTrafficPerSecond&gt;0&lt;/writeTrafficPerSecond&gt;
             &lt;readTrafficPerSecond&gt;0&lt;/readTrafficPerSecond&gt;
-            &lt;checkInterval&gt;1&lt;/checkInterval&gt;
-            &lt;maxDelays&gt;30&lt;/maxDelays&gt;
+            &lt;checkInterval&gt;1000&lt;/checkInterval&gt;
+            &lt;maxDelays&gt;15000&lt;/maxDelays&gt;
         &lt;/trafficShaping&gt;
 &lt;/imapserver&gt;
         </code></pre>


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@james.apache.org
For additional commands, e-mail: notifications-h...@james.apache.org