Package org.axonframework.messaging.core.timeout

Class HandlerTimeoutConfiguration

java.lang.Object

org.axonframework.messaging.core.timeout.HandlerTimeoutConfiguration

public class HandlerTimeoutConfiguration
extends Object

Configuration for the timeout settings of message handlers.

Each specific message type can have its own timeout settings.

Since:

4.11.0

Author:

Mitchell Herrijgers, Steven van Beelen

Field Summary

Fields

Modifier and Type	Field	Description
static final HandlerTimeoutConfiguration	DEFAULT	The HandlerTimeoutConfiguration applied when no other HandlerTimeoutConfiguration component is registered, giving events, commands, and queries alike a 30-second timeout, a 10-second warning threshold, and a 1-second warning interval.
static final HandlerTimeoutConfiguration	DISABLED	HandlerTimeoutConfiguration that will disable handler-specific timeout behavior.

Constructor Summary

Constructors

Constructor	Description
HandlerTimeoutConfiguration(TaskTimeoutSettings events, TaskTimeoutSettings commands, TaskTimeoutSettings queries)	Creates a new HandlerTimeoutConfiguration with the given timeout settings.

Method Summary

Modifier and Type	Method	Description
TaskTimeoutSettings	getCommands()	Retrieves the timeout settings for commands.
TaskTimeoutSettings	getEvents()	Retrieves the timeout settings for events.
TaskTimeoutSettings	getQueries()	Retrieves the timeout settings for queries.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final HandlerTimeoutConfiguration DEFAULT

The HandlerTimeoutConfiguration applied when no other HandlerTimeoutConfiguration component is registered, giving events, commands, and queries alike a 30-second timeout, a 10-second warning threshold, and a 1-second warning interval.

DISABLED

public static final HandlerTimeoutConfiguration DISABLED

HandlerTimeoutConfiguration that will disable handler-specific timeout behavior.

Constructor Details

HandlerTimeoutConfiguration

public HandlerTimeoutConfiguration(TaskTimeoutSettings events,
 TaskTimeoutSettings commands,
 TaskTimeoutSettings queries)

Creates a new HandlerTimeoutConfiguration with the given timeout settings.

Parameters:

events - the timeout settings for events

commands - the timeout settings for commands

queries - the timeout settings for queries

Method Details

getEvents

public TaskTimeoutSettings getEvents()

Retrieves the timeout settings for events.

Returns:

the timeout settings for events

getCommands

public TaskTimeoutSettings getCommands()

Retrieves the timeout settings for commands.

Returns:

the timeout settings for commands

getQueries

public TaskTimeoutSettings getQueries()

Retrieves the timeout settings for queries.

Returns:

the timeout settings for queries