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
CompletableFuture<Void>	onAccountInformationUpdated(int instanceIndex, MetatraderAccountInformation accountInformation) Invoked when MetaTrader account information is updated
CompletableFuture<Void>	onBrokerConnectionStatusChanged(int instanceIndex, boolean connected) Invoked when broker connection satus have changed
CompletableFuture<Void>	onConnected(int instanceIndex, int replicas) Invoked when connection to MetaTrader terminal established
CompletableFuture<Void>	onDealAdded(int instanceIndex, MetatraderDeal deal) Invoked when a new MetaTrader history deal is added
CompletableFuture<Void>	onDealSynchronizationFinished(int instanceIndex, String synchronizationId) Invoked when a synchronization of history deals on a MetaTrader account have finished
CompletableFuture<Void>	onDisconnected(int instanceIndex) Invoked when connection to MetaTrader terminal terminated
CompletableFuture<Void>	onHealthStatus(int instanceIndex, SynchronizationListener.HealthStatus status) Invoked when a server-side application health status is received from MetaApi
CompletableFuture<Void>	onHistoryOrderAdded(int instanceIndex, MetatraderOrder historyOrder) Invoked when a new MetaTrader history order is added
CompletableFuture<Void>	onOrderCompleted(int instanceIndex, String orderId) Invoked when MetaTrader order is completed (executed or canceled)
CompletableFuture<Void>	onOrdersReplaced(int instanceIndex, List<MetatraderOrder> orders) Invoked when the orders are replaced as a result of initial terminal state synchronization
CompletableFuture<Void>	onOrderSynchronizationFinished(int instanceIndex, String synchronizationId) Invoked when a synchronization of history orders on a MetaTrader account have finished
CompletableFuture<Void>	onOrderUpdated(int instanceIndex, MetatraderOrder order) Invoked when MetaTrader order is updated
CompletableFuture<Void>	onPositionRemoved(int instanceIndex, String positionId) Invoked when MetaTrader position is removed
CompletableFuture<Void>	onPositionsReplaced(int instanceIndex, List<MetatraderPosition> positions) Invoked when the positions are replaced as a result of initial terminal state synchronization
CompletableFuture<Void>	onPositionUpdated(int instanceIndex, MetatraderPosition position) Invoked when MetaTrader position is updated
CompletableFuture<Void>	onSymbolPricesUpdated(int instanceIndex, List<MetatraderSymbolPrice> prices, Double equity, Double margin, Double freeMargin, Double marginLevel) Invoked when prices for several symbols were updated
CompletableFuture<Void>	onSymbolPriceUpdated(int instanceIndex, MetatraderSymbolPrice price) Invoked when a symbol price was updated
CompletableFuture<Void>	onSymbolSpecificationUpdated(int instanceIndex, MetatraderSymbolSpecification specification) Invoked when a symbol specification was updated
CompletableFuture<Void>	onSynchronizationStarted(int instanceIndex) Invoked when MetaTrader terminal state synchronization is started

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

onConnected

public CompletableFuture<Void> onConnected(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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(int 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

onSymbolPriceUpdated

public CompletableFuture<Void> onSymbolPriceUpdated(int 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(int instanceIndex,
                                                     List<MetatraderSymbolPrice> prices,
                                                     Double equity,
                                                     Double margin,
                                                     Double freeMargin,
                                                     Double marginLevel)

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, or null

margin - margin used, or null

freeMargin - free margin, or null

marginLevel - margin level calculated as % of equity/margin, or null

Returns:

completable future which resolves when the asynchronous event is processed