cloud.metaapi.sdk.meta_api

Class HistoryStorage

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationListener

cloud.metaapi.sdk.meta_api.HistoryStorage

Direct Known Subclasses:

MemoryHistoryStorage

public abstract class HistoryStorage
extends SynchronizationListener

Abstract class which defines MetaTrader history storage interface.

Nested Class Summary

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

SynchronizationListener.HealthStatus

Constructor Summary

Constructors

Constructor and Description
HistoryStorage()

Method Summary

Modifier and Type	Method and Description
abstract CompletableFuture<Void>	clear() Clears the storage and deletes persistent data
abstract List<MetatraderDeal>	getDeals() Returns all deals stored in history storage
abstract List<MetatraderOrder>	getHistoryOrders() Returns all history orders stored in history storage
CompletableFuture<IsoTime>	getLastDealTime() Returns the time of the last history deal record stored in the history storage
abstract CompletableFuture<IsoTime>	getLastDealTime(Integer instanceIndex) Returns the time of the last history deal record stored in the history storage
abstract Map<Integer,Long>	getLastDealTimeByInstanceIndex() Returns times of last deals by instance indices
CompletableFuture<IsoTime>	getLastHistoryOrderTime() Returns the time of the last history order record stored in the history storage
abstract CompletableFuture<IsoTime>	getLastHistoryOrderTime(Integer instanceIndex) Returns the time of the last history order record stored in the history storage
abstract Map<Integer,Long>	getLastHistoryOrderTimeByInstanceIndex() Returns times of last history orders by instance indices
abstract CompletableFuture<Void>	initialize() Initializes the storage and loads required data from a persistent storage
boolean	isDealSynchronizationFinished() Returns flag indicating whether deal history synchronization have finished
boolean	isOrderSynchronizationFinished() Returns flag indicating whether order history synchronization have finished
abstract CompletableFuture<Void>	loadData() Loads history data from the file manager
CompletableFuture<Void>	onConnected(int instanceIndex, int replicas) Invoked when connection to MetaTrader terminal established
abstract 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
abstract CompletableFuture<Void>	onHistoryOrderAdded(int instanceIndex, MetatraderOrder historyOrder) Invoked when a new MetaTrader history order is added
CompletableFuture<Void>	onOrderSynchronizationFinished(int instanceIndex, String synchronizationId) Invoked when a synchronization of history orders on a MetaTrader account have finished
abstract CompletableFuture<Void>	updateStorage() Saves unsaved history items to storage

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

onAccountInformationUpdated, onBrokerConnectionStatusChanged, onDisconnected, onHealthStatus, onOrderCompleted, onOrdersReplaced, onOrderUpdated, onPositionRemoved, onPositionsReplaced, onPositionUpdated, onSymbolPricesUpdated, onSymbolPriceUpdated, onSymbolSpecificationUpdated, onSynchronizationStarted

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryStorage

public HistoryStorage()

Method Detail

initialize

public abstract CompletableFuture<Void> initialize()

Initializes the storage and loads required data from a persistent storage

Returns:

completable future completed when the storage initialized

getDeals

public abstract List<MetatraderDeal> getDeals()

Returns all deals stored in history storage

Returns:

all deals stored in history storage

getHistoryOrders

public abstract List<MetatraderOrder> getHistoryOrders()

Returns all history orders stored in history storage

Returns:

all history orders stored in history storage

getLastDealTimeByInstanceIndex

public abstract Map<Integer,Long> getLastDealTimeByInstanceIndex()

Returns times of last deals by instance indices

Returns:

map of last deal times by instance indices

getLastHistoryOrderTimeByInstanceIndex

public abstract Map<Integer,Long> getLastHistoryOrderTimeByInstanceIndex()

Returns times of last history orders by instance indices

Returns:

map of last history orders times by instance indices

loadData

public abstract CompletableFuture<Void> loadData()

Loads history data from the file manager

Returns:

completable future which resolves when the history is loaded

updateStorage

public abstract CompletableFuture<Void> updateStorage()

Saves unsaved history items to storage

Returns:

completable future which resolves when storage is updated

isOrderSynchronizationFinished

public boolean isOrderSynchronizationFinished()

Returns flag indicating whether order history synchronization have finished

Returns:

flag indicating whether order history synchronization have finished

isDealSynchronizationFinished

public boolean isDealSynchronizationFinished()

Returns flag indicating whether deal history synchronization have finished

Returns:

flag indicating whether deal history synchronization have finished

clear

public abstract CompletableFuture<Void> clear()

Clears the storage and deletes persistent data

Returns:

completable future completed when the storage cleared

getLastHistoryOrderTime

public CompletableFuture<IsoTime> getLastHistoryOrderTime()

Returns the time of the last history order record stored in the history storage

Returns:

the time of the last history order record stored in the history storage

getLastHistoryOrderTime

public abstract CompletableFuture<IsoTime> getLastHistoryOrderTime(Integer instanceIndex)

Returns the time of the last history order record stored in the history storage

Parameters:

instanceIndex - index of an account instance connected, or null

Returns:

the time of the last history order record stored in the history storage

getLastDealTime

public CompletableFuture<IsoTime> getLastDealTime()

Returns the time of the last history deal record stored in the history storage

Returns:

the time of the last history deal record stored in the history storage

getLastDealTime

public abstract CompletableFuture<IsoTime> getLastDealTime(Integer instanceIndex)

Returns the time of the last history deal record stored in the history storage

Parameters:

instanceIndex - index of an account instance connected, or null

Returns:

the time of the last history deal record stored in the history storage

onHistoryOrderAdded

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

Description copied from class: SynchronizationListener

Invoked when a new MetaTrader history order is added

Overrides:

onHistoryOrderAdded in class SynchronizationListener

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 abstract CompletableFuture<Void> onDealAdded(int instanceIndex,
                                                    MetatraderDeal deal)

Description copied from class: SynchronizationListener

Invoked when a new MetaTrader history deal is added

Overrides:

onDealAdded in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

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

Overrides:

onDealSynchronizationFinished in class SynchronizationListener

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)

Description copied from class: SynchronizationListener

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

Overrides:

onOrderSynchronizationFinished in class SynchronizationListener

Parameters:

instanceIndex - index of an account instance connected

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onConnected

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