cloud.metaapi.sdk.meta_api

Class ConnectionHealthMonitor

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

cloud.metaapi.sdk.meta_api.ConnectionHealthMonitor

public class ConnectionHealthMonitor
extends SynchronizationListener

Tracks connection health status

Nested Class Summary

Nested classes/interfaces inherited from class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

SynchronizationListener.HealthStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	minMeasureInterval
protected static int	minQuoteInterval

Constructor Summary

Constructors

Constructor and Description
ConnectionHealthMonitor(MetaApiConnection connection) Constructs the listener

Method Summary

Modifier and Type	Method and Description
ConnectionHealthStatus	getHealthStatus() Returns health status
protected int	getRandomTimeout()
Optional<SynchronizationListener.HealthStatus>	getServerHealthStatus() Returns server-side application health status
Map<String,Double>	getUptime() Returns uptime in percents measured over specific periods of time
CompletableFuture<Void>	onDisconnected(String instanceIndex) Invoked when connection to MetaTrader terminal terminated
CompletableFuture<Void>	onHealthStatus(String instanceIndex, SynchronizationListener.HealthStatus status) Invoked when a server-side application health status is received from MetaApi
CompletableFuture<Void>	onSymbolPriceUpdated(String instanceIndex, MetatraderSymbolPrice price) Invoked when a symbol price was updated
void	stop() Stops health monitor

Methods inherited from class cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

getHostName, getInstanceNumber, onAccountInformationUpdated, onBooksUpdated, onBrokerConnectionStatusChanged, onCandlesUpdated, onConnected, onDealAdded, onDealSynchronizationFinished, onHistoryOrderAdded, onOrderCompleted, onOrdersReplaced, onOrderSynchronizationFinished, onOrderUpdated, onPositionRemoved, onPositionsReplaced, onPositionUpdated, onStreamClosed, onSubscriptionDowngraded, onSymbolPricesUpdated, onSymbolSpecificationRemoved, onSymbolSpecificationsUpdated, onSymbolSpecificationUpdated, onSynchronizationStarted, onTicksUpdated

Methods inherited from class java.lang.Object

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

Field Detail

minMeasureInterval

protected static int minMeasureInterval

minQuoteInterval

protected static int minQuoteInterval

Constructor Detail

ConnectionHealthMonitor

public ConnectionHealthMonitor(MetaApiConnection connection)

Constructs the listener

Parameters:

connection - MetaApi connection instance

Method Detail

stop

public void stop()

Stops health monitor

onSymbolPriceUpdated

public CompletableFuture<Void> onSymbolPriceUpdated(String instanceIndex,
                                                    MetatraderSymbolPrice price)

Description copied from class: SynchronizationListener

Invoked when a symbol price was updated

Overrides:

onSymbolPriceUpdated in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

price - updated MetaTrader symbol price

Returns:

completable future which resolves when the asynchronous event is processed

onHealthStatus

public CompletableFuture<Void> onHealthStatus(String instanceIndex,
                                              SynchronizationListener.HealthStatus status)

Description copied from class: SynchronizationListener

Invoked when a server-side application health status is received from MetaApi

Overrides:

onHealthStatus in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

status - server-side application health status

Returns:

completable future which resolves when the asynchronous event is processed

onDisconnected

public CompletableFuture<Void> onDisconnected(String instanceIndex)

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal terminated

Overrides:

onDisconnected in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed

getServerHealthStatus

public Optional<SynchronizationListener.HealthStatus> getServerHealthStatus()

Returns server-side application health status

Returns:

server-side application health status

getHealthStatus

public ConnectionHealthStatus getHealthStatus()

Returns health status

Returns:

connection health status

getUptime

public Map<String,Double> getUptime()

Returns uptime in percents measured over specific periods of time

Returns:

uptime in percents measured over specific periods of time

getRandomTimeout

protected int getRandomTimeout()