From 4bbc1fd683b3614d2cc6247dd16cdc8222e100dd Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Thu, 5 Sep 2024 00:47:24 +0200 Subject: [PATCH] Add more documentation to loggerPollingSpeed setting --- .../sosengine/base/EngineConfiguration.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java index 3a4aa8c..747b9fe 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java @@ -218,16 +218,20 @@ public final class EngineConfiguration extends Configuration { /** * Contains how fast the logging thread will poll for queued messages. + * This also causes messages to be buffered. + *

* Only applies if {@code optimizeLogging} is turned on. + * Values below {@code 1} will poll for queued messages as fast as it can. + * This however has pretty much no benefit. Leave it at {@code 5}, it works quite well. * * @see #optimizeLogging - * @since v1-alpha1 + * @since v1-alpha4 * -- GETTER -- * Gets the value for {@link #loggerPollingSpeed}. * * @return variable value * @see #loggerPollingSpeed - * @since v1-alpha1 + * @since v1-alpha4 */ private int loggerPollingSpeed;