cloud.metaapi.sdk.clients.meta_api

Class SynchronizationListener

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

Direct Known Subclasses:

ConnectionHealthMonitor, HistoryStorage, MetaApiConnection, TerminalState

public abstract class SynchronizationListener
extends Object

Defines abstract class for a synchronization listener class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynchronizationListener.HealthStatus Server-side application health status

Constructor Summary

Constructors

Constructor and Description
SynchronizationListener()

Method Summary

Modifier and Type	Method and Description
String	getHostName(String instanceIndex) Returns host name of instance index
Integer	getInstanceNumber(String instanceIndex) Returns instance number of instance index
CompletableFuture<Void>	onAccountInformationUpdated(String instanceIndex, MetatraderAccountInformation accountInformation) Invoked when MetaTrader account information is updated
CompletableFuture<Void>	onBooksUpdated(String instanceIndex, List<MetatraderBook> books, Double equity, Double margin, Double freeMargin, Double marginLevel, Double accountCurrencyExchangeRate) Invoked when order books were updated
CompletableFuture<Void>	onBrokerConnectionStatusChanged(String instanceIndex, boolean connected) Invoked when broker connection satus have changed
CompletableFuture<Void>	onCandlesUpdated(String instanceIndex, List<MetatraderCandle> candles, Double equity, Double margin, Double freeMargin, Double marginLevel, Double accountCurrencyExchangeRate) Invoked when symbol candles were updated
CompletableFuture<Void>	onConnected(String instanceIndex, int replicas) Invoked when connection to MetaTrader terminal established
CompletableFuture<Void>	onDealAdded(String instanceIndex, MetatraderDeal deal) Invoked when a new MetaTrader history deal is added
CompletableFuture<Void>	onDealSynchronizationFinished(String instanceIndex, String synchronizationId) Invoked when a synchronization of history deals on a MetaTrader account have finished
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>	onHistoryOrderAdded(String instanceIndex, MetatraderOrder historyOrder) Invoked when a new MetaTrader history order is added
CompletableFuture<Void>	onOrderCompleted(String instanceIndex, String orderId) Invoked when MetaTrader order is completed (executed or canceled)
CompletableFuture<Void>	onOrdersReplaced(String instanceIndex, List<MetatraderOrder> orders) Invoked when the orders are replaced as a result of initial terminal state synchronization
CompletableFuture<Void>	onOrderSynchronizationFinished(String instanceIndex, String synchronizationId) Invoked when a synchronization of history orders on a MetaTrader account have finished
CompletableFuture<Void>	onOrderUpdated(String instanceIndex, MetatraderOrder order) Invoked when MetaTrader order is updated
CompletableFuture<Void>	onPositionRemoved(String instanceIndex, String positionId) Invoked when MetaTrader position is removed
CompletableFuture<Void>	onPositionsReplaced(String instanceIndex, List<MetatraderPosition> positions) Invoked when the positions are replaced as a result of initial terminal state synchronization
CompletableFuture<Void>	onPositionUpdated(String instanceIndex, MetatraderPosition position) Invoked when MetaTrader position is updated
CompletableFuture<Void>	onStreamClosed(String instanceIndex) Invoked when a stream for an instance index is closed
CompletableFuture<Void>	onSubscriptionDowngraded(String instanceIndex, String symbol, List<MarketDataSubscription> updates, List<MarketDataUnsubscription> unsubscriptions) Invoked when subscription downgrade has occurred
CompletableFuture<Void>	onSymbolPricesUpdated(String instanceIndex, List<MetatraderSymbolPrice> prices, Double equity, Double margin, Double freeMargin, Double marginLevel, Double accountCurrencyExchangeRate) Invoked when prices for several symbols were updated
CompletableFuture<Void>	onSymbolPriceUpdated(String instanceIndex, MetatraderSymbolPrice price) Invoked when a symbol price was updated
CompletableFuture<Void>	onSymbolSpecificationRemoved(String instanceIndex, String symbol) Invoked when a symbol specification was removed
CompletableFuture<Void>	onSymbolSpecificationsUpdated(String instanceIndex, List<MetatraderSymbolSpecification> specifications, List<String> removedSymbols) Invoked when a symbol specifications were updated
CompletableFuture<Void>	onSymbolSpecificationUpdated(String instanceIndex, MetatraderSymbolSpecification specification) Invoked when a symbol specification was updated
CompletableFuture<Void>	onSynchronizationStarted(String instanceIndex) Invoked when MetaTrader terminal state synchronization is started
CompletableFuture<Void>	onTicksUpdated(String instanceIndex, List<MetatraderTick> ticks, Double equity, Double margin, Double freeMargin, Double marginLevel, Double accountCurrencyExchangeRate) Invoked when symbol ticks were updated

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizationListener

public SynchronizationListener()

Method Detail

getInstanceNumber

public Integer getInstanceNumber(String instanceIndex)

Returns instance number of instance index

Parameters:

instanceIndex - instance index

Returns:

instance number or null

getHostName

public String getHostName(String instanceIndex)

Returns host name of instance index

Parameters:

instanceIndex - instance index

Returns:

host name or null

onConnected

public CompletableFuture<Void> onConnected(String instanceIndex,
                                           int replicas)

Invoked when connection to MetaTrader terminal established

Parameters:

instanceIndex - index of an account instance connected

replicas - number of account replicas launched

Returns:

completable future which resolves when the asynchronous event is processed

onHealthStatus

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

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

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)

Invoked when connection to MetaTrader terminal terminated

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed

onBrokerConnectionStatusChanged

public CompletableFuture<Void> onBrokerConnectionStatusChanged(String instanceIndex,
                                                               boolean connected)

Invoked when broker connection satus have changed

Parameters:

instanceIndex - index of an account instance connected

connected - is MetaTrader terminal is connected to broker

Returns:

completable future which resolves when the asynchronous event is processed

onSynchronizationStarted

public CompletableFuture<Void> onSynchronizationStarted(String instanceIndex)

Invoked when MetaTrader terminal state synchronization is started

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed

onAccountInformationUpdated

public CompletableFuture<Void> onAccountInformationUpdated(String instanceIndex,
                                                           MetatraderAccountInformation accountInformation)

Invoked when MetaTrader account information is updated

Parameters:

instanceIndex - index of an account instance connected

accountInformation - updated MetaTrader account information

Returns:

completable future which resolves when the asynchronous event is processed

onPositionsReplaced

public CompletableFuture<Void> onPositionsReplaced(String instanceIndex,
                                                   List<MetatraderPosition> positions)

Invoked when the positions are replaced as a result of initial terminal state synchronization

Parameters:

instanceIndex - index of an account instance connected

positions - updated array of positions

Returns:

completable future which resolves when the asynchronous event is processed

onPositionUpdated

public CompletableFuture<Void> onPositionUpdated(String instanceIndex,
                                                 MetatraderPosition position)

Invoked when MetaTrader position is updated

Parameters:

instanceIndex - index of an account instance connected

position - updated MetaTrader position

Returns:

completable future which resolves when the asynchronous event is processed

onPositionRemoved

public CompletableFuture<Void> onPositionRemoved(String instanceIndex,
                                                 String positionId)

Invoked when MetaTrader position is removed

Parameters:

instanceIndex - index of an account instance connected

positionId - removed MetaTrader position id

Returns:

completable future which resolves when the asynchronous event is processed

onOrdersReplaced

public CompletableFuture<Void> onOrdersReplaced(String instanceIndex,
                                                List<MetatraderOrder> orders)

Invoked when the orders are replaced as a result of initial terminal state synchronization

Parameters:

instanceIndex - index of an account instance connected

orders - updated array of orders

Returns:

completable future which resolves when the asynchronous event is processed

onOrderUpdated

public CompletableFuture<Void> onOrderUpdated(String instanceIndex,
                                              MetatraderOrder order)

Invoked when MetaTrader order is updated

Parameters:

instanceIndex - index of an account instance connected

order - updated MetaTrader order

Returns:

completable future which resolves when the asynchronous event is processed

onOrderCompleted

public CompletableFuture<Void> onOrderCompleted(String instanceIndex,
                                                String orderId)

Invoked when MetaTrader order is completed (executed or canceled)

Parameters:

instanceIndex - index of an account instance connected

orderId - completed MetaTrader order id

Returns:

completable future which resolves when the asynchronous event is processed

onHistoryOrderAdded

public CompletableFuture<Void> onHistoryOrderAdded(String instanceIndex,
                                                   MetatraderOrder historyOrder)

Invoked when a new MetaTrader history order is added

Parameters:

instanceIndex - index of an account instance connected

historyOrder - new MetaTrader history order

Returns:

completable future which resolves when the asynchronous event is processed

onDealAdded

public CompletableFuture<Void> onDealAdded(String instanceIndex,
                                           MetatraderDeal deal)

Invoked when a new MetaTrader history deal is added

Parameters:

instanceIndex - index of an account instance connected

deal - new MetaTrader history deal

Returns:

completable future which resolves when the asynchronous event is processed

onDealSynchronizationFinished

public CompletableFuture<Void> onDealSynchronizationFinished(String instanceIndex,
                                                             String synchronizationId)

Invoked when a synchronization of history deals on a MetaTrader account have finished

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onOrderSynchronizationFinished

public CompletableFuture<Void> onOrderSynchronizationFinished(String instanceIndex,
                                                              String synchronizationId)

Invoked when a synchronization of history orders on a MetaTrader account have finished

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolSpecificationUpdated

public CompletableFuture<Void> onSymbolSpecificationUpdated(String instanceIndex,
                                                            MetatraderSymbolSpecification specification)

Invoked when a symbol specification was updated

Parameters:

instanceIndex - index of an account instance connected

specification - updated MetaTrader symbol specification

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolSpecificationRemoved

public CompletableFuture<Void> onSymbolSpecificationRemoved(String instanceIndex,
                                                            String symbol)

Invoked when a symbol specification was removed

Parameters:

instanceIndex - index of an account instance connected

symbol - removed symbol

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolSpecificationsUpdated

public CompletableFuture<Void> onSymbolSpecificationsUpdated(String instanceIndex,
                                                             List<MetatraderSymbolSpecification> specifications,
                                                             List<String> removedSymbols)

Invoked when a symbol specifications were updated

Parameters:

instanceIndex - index of account instance connected

specifications - updated specifications

removedSymbols - removed symbols

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolPriceUpdated

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

Invoked when a symbol price was updated

Parameters:

instanceIndex - index of an account instance connected

price - updated MetaTrader symbol price

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolPricesUpdated

public CompletableFuture<Void> onSymbolPricesUpdated(String instanceIndex,
                                                     List<MetatraderSymbolPrice> prices,
                                                     Double equity,
                                                     Double margin,
                                                     Double freeMargin,
                                                     Double marginLevel,
                                                     Double accountCurrencyExchangeRate)

Invoked when prices for several symbols were updated

Parameters:

instanceIndex - index of an account instance connected

prices - updated MetaTrader symbol prices

equity - account liquidation value

margin - margin used

freeMargin - free margin

marginLevel - margin level calculated as % of equity/margin

accountCurrencyExchangeRate - current exchange rate of account currency into USD

Returns:

completable future which resolves when the asynchronous event is processed

onCandlesUpdated

public CompletableFuture<Void> onCandlesUpdated(String instanceIndex,
                                                List<MetatraderCandle> candles,
                                                Double equity,
                                                Double margin,
                                                Double freeMargin,
                                                Double marginLevel,
                                                Double accountCurrencyExchangeRate)

Invoked when symbol candles were updated

Parameters:

instanceIndex - index of an account instance connected

candles - updated MetaTrader symbol candles

equity - account liquidation value

margin - margin used

freeMargin - free margin

marginLevel - margin level calculated as % of equity/margin

accountCurrencyExchangeRate - current exchange rate of account currency into USD

Returns:

completable future which resolves when the asynchronous event is processed

onTicksUpdated

public CompletableFuture<Void> onTicksUpdated(String instanceIndex,
                                              List<MetatraderTick> ticks,
                                              Double equity,
                                              Double margin,
                                              Double freeMargin,
                                              Double marginLevel,
                                              Double accountCurrencyExchangeRate)

Invoked when symbol ticks were updated

Parameters:

instanceIndex - index of an account instance connected

ticks - updated MetaTrader symbol ticks

equity - account liquidation value

margin - margin used

freeMargin - free margin

marginLevel - margin level calculated as % of equity/margin

accountCurrencyExchangeRate - current exchange rate of account currency into USD

Returns:

completable future which resolves when the asynchronous event is processed

onBooksUpdated

public CompletableFuture<Void> onBooksUpdated(String instanceIndex,
                                              List<MetatraderBook> books,
                                              Double equity,
                                              Double margin,
                                              Double freeMargin,
                                              Double marginLevel,
                                              Double accountCurrencyExchangeRate)

Invoked when order books were updated

Parameters:

instanceIndex - index of an account instance connected

books - updated MetaTrader order books

equity - account liquidation value

margin - margin used

freeMargin - free margin

marginLevel - margin level calculated as % of equity/margin

accountCurrencyExchangeRate - current exchange rate of account currency into USD

Returns:

completable future which resolves when the asynchronous event is processed

onSubscriptionDowngraded

public CompletableFuture<Void> onSubscriptionDowngraded(String instanceIndex,
                                                        String symbol,
                                                        List<MarketDataSubscription> updates,
                                                        List<MarketDataUnsubscription> unsubscriptions)

Invoked when subscription downgrade has occurred

Parameters:

instanceIndex - index of an account instance connected

symbol - symbol to update subscriptions for

updates - array of market data subscription to update

unsubscriptions - array of subscriptions to cancel

Returns:

completable future which resolves when the asynchronous event is processed

onStreamClosed

public CompletableFuture<Void> onStreamClosed(String instanceIndex)

Invoked when a stream for an instance index is closed

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed