cloud.metaapi.sdk.meta_api

Class TerminalState

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

cloud.metaapi.sdk.meta_api.TerminalState

public class TerminalState
extends SynchronizationListener

Responsible for storing a local copy of remote terminal state

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 int	statusTimerTimeoutInMilliseconds Defines timeout of waiting for a broker connection status changed signal.

Constructor Summary

Constructors

Constructor and Description
TerminalState()

Method Summary

Modifier and Type	Method and Description
Optional<MetatraderAccountInformation>	getAccountInformation() Returns a local copy of account information
List<MetatraderOrder>	getOrders() Returns a local copy of MetaTrader orders opened
List<MetatraderPosition>	getPositions() Returns a local copy of MetaTrader positions opened
Optional<MetatraderSymbolPrice>	getPrice(String symbol) Returns MetaTrader symbol price by symbol
Optional<MetatraderSymbolSpecification>	getSpecification(String symbol) Returns MetaTrader symbol specification by symbol
List<MetatraderSymbolSpecification>	getSpecifications() Returns a local copy of symbol specifications available in MetaTrader trading terminal
boolean	isConnected() Returns true if MetaApi have connected to MetaTrader terminal
boolean	isConnectedToBroker() Returns true if MetaApi have connected to MetaTrader terminal and MetaTrader terminal is connected to broker
CompletableFuture<Void>	onAccountInformationUpdated(String instanceIndex, MetatraderAccountInformation accountInformation) Invoked when MetaTrader account information is updated
CompletableFuture<Void>	onBrokerConnectionStatusChanged(String instanceIndex, boolean connected) Invoked when broker connection satus have changed
CompletableFuture<Void>	onConnected(String instanceIndex, int replicas) Invoked when connection to MetaTrader terminal established
CompletableFuture<Void>	onDisconnected(String instanceIndex) Invoked when connection to MetaTrader terminal terminated
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>	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>	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>	onSymbolSpecificationsUpdated(String instanceIndex, List<MetatraderSymbolSpecification> specifications, List<String> removedSymbols) Invoked when a symbol specifications were updated
CompletableFuture<Void>	onSynchronizationStarted(String instanceIndex) Invoked when MetaTrader terminal state synchronization is started
CompletableFuture<Optional<MetatraderSymbolPrice>>	waitForPrice(String symbol) Waits for price to be received
CompletableFuture<Optional<MetatraderSymbolPrice>>	waitForPrice(String symbol, Long timeoutInSeconds) Waits for price to be received

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

getHostName, getInstanceNumber, onBooksUpdated, onCandlesUpdated, onDealAdded, onDealSynchronizationFinished, onHealthStatus, onHistoryOrderAdded, onOrderSynchronizationFinished, onSubscriptionDowngraded, onSymbolPriceUpdated, onSymbolSpecificationRemoved, onSymbolSpecificationUpdated, onTicksUpdated

Methods inherited from class java.lang.Object

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

Field Detail

statusTimerTimeoutInMilliseconds

protected int statusTimerTimeoutInMilliseconds

Defines timeout of waiting for a broker connection status changed signal. Intended to be used in tests for reducing a test time execution.

Constructor Detail

TerminalState

public TerminalState()

Method Detail

isConnected

public boolean isConnected()

Returns true if MetaApi have connected to MetaTrader terminal

Returns:

true if MetaApi have connected to MetaTrader terminal

isConnectedToBroker

public boolean isConnectedToBroker()

Returns true if MetaApi have connected to MetaTrader terminal and MetaTrader terminal is connected to broker

Returns:

true if MetaApi have connected to MetaTrader terminal and MetaTrader terminal is connected to broker

getAccountInformation

public Optional<MetatraderAccountInformation> getAccountInformation()

Returns a local copy of account information

Returns:

local copy of account information

getPositions

public List<MetatraderPosition> getPositions()

Returns a local copy of MetaTrader positions opened

Returns:

a local copy of MetaTrader positions opened

getOrders

public List<MetatraderOrder> getOrders()

Returns a local copy of MetaTrader orders opened

Returns:

a local copy of MetaTrader orders opened

getSpecifications

public List<MetatraderSymbolSpecification> getSpecifications()

Returns a local copy of symbol specifications available in MetaTrader trading terminal

Returns:

a local copy of symbol specifications available in MetaTrader trading terminal

getSpecification

public Optional<MetatraderSymbolSpecification> getSpecification(String symbol)

Returns MetaTrader symbol specification by symbol

Parameters:

symbol - symbol (e.g. currency pair or an index)

Returns:

Optional of MetatraderSymbolSpecification found or empty Optional if specification for a symbol is not found

getPrice

public Optional<MetatraderSymbolPrice> getPrice(String symbol)

Returns MetaTrader symbol price by symbol

Parameters:

symbol - symbol (e.g. currency pair or an index)

Returns:

Optional of MetatraderSymbolPrice found or empty Optional if price for a symbol is not found

waitForPrice

public CompletableFuture<Optional<MetatraderSymbolPrice>> waitForPrice(String symbol)

Waits for price to be received

Parameters:

symbol - symbol (e.g. currency pair or an index)

Returns:

completable future resolving with price or null if price has not been received

waitForPrice

public CompletableFuture<Optional<MetatraderSymbolPrice>> waitForPrice(String symbol,
                                                                       Long timeoutInSeconds)

Waits for price to be received

Parameters:

symbol - symbol (e.g. currency pair or an index)

timeoutInSeconds - timeout in seconds, or null. Default is 30

Returns:

completable future resolving with price or empty optional value if price has not been received

onConnected

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

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal established

Overrides:

onConnected in class SynchronizationListener

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

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

onBrokerConnectionStatusChanged

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

Description copied from class: SynchronizationListener

Invoked when broker connection satus have changed

Overrides:

onBrokerConnectionStatusChanged in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader terminal state synchronization is started

Overrides:

onSynchronizationStarted in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader account information is updated

Overrides:

onAccountInformationUpdated in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

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

Overrides:

onPositionsReplaced in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader position is updated

Overrides:

onPositionUpdated in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader position is removed

Overrides:

onPositionRemoved in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

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

Overrides:

onOrdersReplaced in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader order is updated

Overrides:

onOrderUpdated in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

Invoked when MetaTrader order is completed (executed or canceled)

Overrides:

onOrderCompleted in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

orderId - completed MetaTrader order id

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolSpecificationsUpdated

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

Description copied from class: SynchronizationListener

Invoked when a symbol specifications were updated

Overrides:

onSymbolSpecificationsUpdated in class SynchronizationListener

Parameters:

instanceIndex - index of account instance connected

specifications - updated specifications

removedSymbols - removed symbols

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)

Description copied from class: SynchronizationListener

Invoked when prices for several symbols were updated

Overrides:

onSymbolPricesUpdated in class SynchronizationListener

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

onStreamClosed

public CompletableFuture<Void> onStreamClosed(String instanceIndex)

Description copied from class: SynchronizationListener

Invoked when a stream for an instance index is closed

Overrides:

onStreamClosed in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

Returns:

completable future which resolves when the asynchronous event is processed