org.axonframework.axonserver.connector.heartbeat

Class HeartbeatConfiguration

java.lang.Object

org.axonframework.axonserver.connector.heartbeat.HeartbeatConfiguration

All Implemented Interfaces:

ModuleConfiguration

public class HeartbeatConfiguration
extends Object
implements ModuleConfiguration

Module configuration that defines the components needed to enable heartbeat and monitor the availability of the connection with AxonServer.

Since:

4.2.1

Author:

Sara Pellegrini

Constructor Summary

Constructors

Constructor and Description
HeartbeatConfiguration() Default constructor for HeartbeatConfiguration, that uses Configuration in order to retrieve the registered AxonServerConnectionManager and AxonServerConfiguration.
HeartbeatConfiguration(Function<Configuration,AxonServerConnectionManager> connectionManagerSupplier, Function<Configuration,AxonServerConfiguration> axonServerConfigurationSupplier) Creates a HeartbeatConfiguration using the provided functions to retrieve the AxonServerConnectionManager and AxonServerConfiguration.

Method Summary

Modifier and Type	Method and Description
void	initialize(Configuration config) Initializes the GrpcHeartbeatSource component, needed to send heartbeats to AxonServer, any time the client will receive an heartbeat from the server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.config.ModuleConfiguration

isType, phase, shutdown, start, unwrap

Constructor Detail

HeartbeatConfiguration

public HeartbeatConfiguration()

Default constructor for HeartbeatConfiguration, that uses Configuration in order to retrieve the registered AxonServerConnectionManager and AxonServerConfiguration.

HeartbeatConfiguration

public HeartbeatConfiguration(Function<Configuration,AxonServerConnectionManager> connectionManagerSupplier,
                              Function<Configuration,AxonServerConfiguration> axonServerConfigurationSupplier)

Creates a HeartbeatConfiguration using the provided functions to retrieve the AxonServerConnectionManager and AxonServerConfiguration.

Parameters:

connectionManagerSupplier - function to retrieve the AxonServerConnectionManager from Configuration

axonServerConfigurationSupplier - function to retrieve the AxonServerConfiguration from Configuration

Method Detail

initialize

public void initialize(Configuration config)

Initializes the GrpcHeartbeatSource component, needed to send heartbeats to AxonServer, any time the client will receive an heartbeat from the server.

Initializes the HeartbeatMonitor component, needed to force a disconnection if the communication between the client and the server is no longer available.

Specified by:

initialize in interface ModuleConfiguration

Parameters:

config - the global configuration, providing access to generic components