JeremyStarTM/Engine
1
0
Fork 0
forked from StarOpenSource/Engine
Code Pull requests Activity Actions

Add more documentation to loggerPollingSpeed setting

Browse source
This commit is contained in:
JeremyStar™ 2024-09-05 00:47:24 +02:00
parent 770c9b5c6e
commit 4bbc1fd683
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java
View file

@ -218,16 +218,20 @@ public final class EngineConfiguration extends Configuration {
/** /**
* Contains how fast the logging thread will poll for queued messages. * Contains how fast the logging thread will poll for queued messages.
* This also causes messages to be buffered.
* <p>
* Only applies if {@code optimizeLogging} is turned on. * 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 * @see #optimizeLogging
* @since v1-alpha1 * @since v1-alpha4
* -- GETTER -- * -- GETTER --
* Gets the value for {@link #loggerPollingSpeed}. * Gets the value for {@link #loggerPollingSpeed}.
* *
* @return variable value * @return variable value
* @see #loggerPollingSpeed * @see #loggerPollingSpeed
* @since v1-alpha1 * @since v1-alpha4
*/ */
private int loggerPollingSpeed; private int loggerPollingSpeed;