org.axonframework.messaging.timeout

Class TaskTimeoutSettings

java.lang.Object

org.axonframework.messaging.timeout.TaskTimeoutSettings

public class TaskTimeoutSettings
extends Object

Configuration properties for a task timeout. Used in other parts of the configuration.

Since:

4.11.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor and Description
TaskTimeoutSettings() Creates a new TaskTimeoutSettings with default timeout settings.
TaskTimeoutSettings(int timeoutMs, int warningThresholdMs, int warningIntervalMs) Creates a new TaskTimeoutSettings with the provided timeout settings.

Method Summary

Modifier and Type	Method and Description
int	getTimeoutMs() Returns the timeout of the message handler in milliseconds.
int	getWarningIntervalMs() Returns the interval in milliseconds between warnings.
int	getWarningThresholdMs() Returns the threshold in milliseconds after which a warning is logged.
void	setTimeoutMs(int timeoutMs) Sets the timeout of the message handler in milliseconds.
void	setWarningIntervalMs(int warningIntervalMs) Sets the interval in milliseconds between warnings.
void	setWarningThresholdMs(int warningThresholdMs) Sets the threshold in milliseconds after which a warning is logged.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskTimeoutSettings

public TaskTimeoutSettings(int timeoutMs,
                           int warningThresholdMs,
                           int warningIntervalMs)

Creates a new TaskTimeoutSettings with the provided timeout settings.

Parameters:

timeoutMs - the timeout in milliseconds

warningThresholdMs - the threshold in milliseconds after which a warning is logged. Setting this to a value higher than or equal to timeout will disable warnings.

warningIntervalMs - the interval in milliseconds between warnings

TaskTimeoutSettings

public TaskTimeoutSettings()

Creates a new TaskTimeoutSettings with default timeout settings. This means all timeouts are disabled.

Method Detail

getTimeoutMs

public int getTimeoutMs()

Returns the timeout of the message handler in milliseconds.

Returns:

the timeout of the message handler in milliseconds

setTimeoutMs

public void setTimeoutMs(int timeoutMs)

Sets the timeout of the message handler in milliseconds.

Parameters:

timeoutMs - the timeout of the message handler in milliseconds

getWarningThresholdMs

public int getWarningThresholdMs()

Returns the threshold in milliseconds after which a warning is logged. Setting this to a value higher than timeout will disable warnings.

Returns:

the threshold in milliseconds after which a warning is logged

setWarningThresholdMs

public void setWarningThresholdMs(int warningThresholdMs)

Sets the threshold in milliseconds after which a warning is logged. Setting this to a value higher than or equal to timeout will disable warnings.

Parameters:

warningThresholdMs - the threshold in milliseconds after which a warning is logged

getWarningIntervalMs

public int getWarningIntervalMs()

Returns the interval in milliseconds between warnings.

Returns:

the interval in milliseconds between warnings

setWarningIntervalMs

public void setWarningIntervalMs(int warningIntervalMs)

Sets the interval in milliseconds between warnings.

Parameters:

warningIntervalMs - the interval in milliseconds between warnings