org.axonframework.axonserver.connector

Class AxonServerConfiguration.HeartbeatConfiguration

java.lang.Object

org.axonframework.axonserver.connector.AxonServerConfiguration.HeartbeatConfiguration

Enclosing class:

AxonServerConfiguration

public static class AxonServerConfiguration.HeartbeatConfiguration
extends Object

Constructor Summary

Constructors

Constructor and Description
HeartbeatConfiguration()

Method Summary

Modifier and Type	Method and Description
long	getInterval() The interval between consecutive heartbeat message sent in milliseconds.
long	getTimeout() The time window within which a response is expected in milliseconds.
boolean	isEnabled() Indication whether heartbeat messages between a client and Axon Server are enabled.
void	setEnabled(boolean enabled) Sets the indication whether heartbeat messages between a client and Axon Server are enabled.
void	setInterval(long interval) Sets the interval between consecutive heartbeat message sent in milliseconds.
void	setTimeout(long timeout) Sets the time window within which a response is expected in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatConfiguration

public HeartbeatConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

Indication whether heartbeat messages between a client and Axon Server are enabled. When enabled, the connection will be abandoned if a heartbeat message response is not returned in a timely manner. Defaults to true.

Returns:

Indication whether heartbeat messages between a client and Axon Server are enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets the indication whether heartbeat messages between a client and Axon Server are enabled. When enabled, the connection will be abandoned if a heartbeat message response is not returned in a timely manner. Defaults to true.

Parameters:

enabled - The Indication whether heartbeat messages between a client and Axon Server are enabled.

getInterval

public long getInterval()

The interval between consecutive heartbeat message sent in milliseconds. Defaults to 10_000 milliseconds.

Returns:

The interval between consecutive heartbeat message sent in milliseconds.

setInterval

public void setInterval(long interval)

Sets the interval between consecutive heartbeat message sent in milliseconds. Defaults to 10_000 milliseconds.

Parameters:

interval - The interval between consecutive heartbeat message sent in milliseconds.

getTimeout

public long getTimeout()

The time window within which a response is expected in milliseconds. The connection times out if no response is returned within this window. Defaults to 7_500 milliseconds.

Returns:

The time window within which a response is expected in milliseconds.

setTimeout

public void setTimeout(long timeout)

Sets the time window within which a response is expected in milliseconds. The connection times out if no response is returned within this window. Defaults to 7_500 milliseconds.

Parameters:

timeout - The time window within which a response is expected in milliseconds.