Package 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

Field Summary

Fields

Modifier and Type	Field	Description
protected int	statusTimerTimeoutInMilliseconds	Defines timeout of waiting for a broker connection status changed signal.

Constructor Summary

Constructors

Constructor	Description
TerminalState()

Method Summary

Modifier and Type	Method	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(MetatraderAccountInformation accountInformation)	Invoked when MetaTrader account information is updated
CompletableFuture<Void>	onBrokerConnectionStatusChanged(boolean connected)	Invoked when broker connection satus have changed
CompletableFuture<Void>	onConnected()	Invoked when connection to MetaTrader terminal established
CompletableFuture<Void>	onDisconnected()	Invoked when connection to MetaTrader terminal terminated
CompletableFuture<Void>	onOrderCompleted(String orderId)	Invoked when MetaTrader order is completed (executed or canceled)
CompletableFuture<Void>	onOrderUpdated(MetatraderOrder order)	Invoked when MetaTrader order is updated
CompletableFuture<Void>	onPositionRemoved(String positionId)	Invoked when MetaTrader position is removed
CompletableFuture<Void>	onPositionUpdated(MetatraderPosition position)	Invoked when MetaTrader position is updated
CompletableFuture<Void>	onSymbolPriceUpdated(MetatraderSymbolPrice price)	Invoked when a symbol price was updated
CompletableFuture<Void>	onSymbolSpecificationUpdated(MetatraderSymbolSpecification specification)	Invoked when a symbol specification was updated

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

onDealAdded, onDealSynchronizationFinished, onHistoryOrderAdded, onOrderSynchronizationFinished

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

getPositions

public List<MetatraderPosition> getPositions()

Returns a local copy of MetaTrader positions opened

getOrders

public List<MetatraderOrder> getOrders()

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

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

onConnected

public CompletableFuture<Void> onConnected()

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal established

Overrides:

onConnected in class SynchronizationListener

Returns:

completable future which resolves when the asynchronous event is processed

onDisconnected

public CompletableFuture<Void> onDisconnected()

Description copied from class: SynchronizationListener

Invoked when connection to MetaTrader terminal terminated

Overrides:

onDisconnected in class SynchronizationListener

Returns:

completable future which resolves when the asynchronous event is processed

onBrokerConnectionStatusChanged

public CompletableFuture<Void> onBrokerConnectionStatusChanged(boolean connected)

Description copied from class: SynchronizationListener

Invoked when broker connection satus have changed

Overrides:

onBrokerConnectionStatusChanged in class SynchronizationListener

Parameters:

connected - is MetaTrader terminal is connected to broker

Returns:

completable future which resolves when the asynchronous event is processed

onAccountInformationUpdated

public CompletableFuture<Void> onAccountInformationUpdated(MetatraderAccountInformation accountInformation)

Description copied from class: SynchronizationListener

Invoked when MetaTrader account information is updated

Overrides:

onAccountInformationUpdated in class SynchronizationListener

Parameters:

accountInformation - updated MetaTrader account information

Returns:

completable future which resolves when the asynchronous event is processed

onPositionUpdated

public CompletableFuture<Void> onPositionUpdated(MetatraderPosition position)

Description copied from class: SynchronizationListener

Invoked when MetaTrader position is updated

Overrides:

onPositionUpdated in class SynchronizationListener

Parameters:

position - updated MetaTrader position

Returns:

completable future which resolves when the asynchronous event is processed

onPositionRemoved

public CompletableFuture<Void> onPositionRemoved(String positionId)

Description copied from class: SynchronizationListener

Invoked when MetaTrader position is removed

Overrides:

onPositionRemoved in class SynchronizationListener

Parameters:

positionId - removed MetaTrader position id

Returns:

completable future which resolves when the asynchronous event is processed

onOrderUpdated

public CompletableFuture<Void> onOrderUpdated(MetatraderOrder order)

Description copied from class: SynchronizationListener

Invoked when MetaTrader order is updated

Overrides:

onOrderUpdated in class SynchronizationListener

Parameters:

order - updated MetaTrader order

Returns:

completable future which resolves when the asynchronous event is processed

onOrderCompleted

public CompletableFuture<Void> onOrderCompleted(String orderId)

Description copied from class: SynchronizationListener

Invoked when MetaTrader order is completed (executed or canceled)

Overrides:

onOrderCompleted in class SynchronizationListener

Parameters:

orderId - completed MetaTrader order id

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolSpecificationUpdated

public CompletableFuture<Void> onSymbolSpecificationUpdated(MetatraderSymbolSpecification specification)

Description copied from class: SynchronizationListener

Invoked when a symbol specification was updated

Overrides:

onSymbolSpecificationUpdated in class SynchronizationListener

Parameters:

specification - updated MetaTrader symbol specification

Returns:

completable future which resolves when the asynchronous event is processed

onSymbolPriceUpdated

public CompletableFuture<Void> onSymbolPriceUpdated(MetatraderSymbolPrice price)

Description copied from class: SynchronizationListener

Invoked when a symbol price was updated

Overrides:

onSymbolPriceUpdated in class SynchronizationListener

Parameters:

price - updated MetaTrader symbol price

Returns:

completable future which resolves when the asynchronous event is processed