Package 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.

Constructor Summary

Constructors

Constructor	Description
HistoryStorage()

Method Summary

Modifier and Type	Method	Description
abstract List<MetatraderDeal>	getDeals()	Returns all deals stored in history storage
abstract List<MetatraderOrder>	getHistoryOrders()	Returns all history orders stored in history storage
abstract CompletableFuture<IsoTime>	getLastDealTime()	Returns the time of the last history deal record stored in the history storage
abstract CompletableFuture<IsoTime>	getLastHistoryOrderTime()	Returns the time of the last history order record stored in the history 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()	Invoked when connection to MetaTrader terminal established
abstract CompletableFuture<Void>	onDealAdded(MetatraderDeal deal)	Invoked when a new MetaTrader history deal is added
CompletableFuture<Void>	onDealSynchronizationFinished(String synchronizationId)	Invoked when a synchronization of history deals on a MetaTrader account have finished
abstract CompletableFuture<Void>	onHistoryOrderAdded(MetatraderOrder historyOrder)	Invoked when a new MetaTrader history order is added
CompletableFuture<Void>	onOrderSynchronizationFinished(String synchronizationId)	Invoked when a synchronization of history orders on a MetaTrader account have finished
abstract void	reset()	Resets the storage
abstract CompletableFuture<Void>	updateStorage()	Saves unsaved history items to storage

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

onAccountInformationUpdated, onBrokerConnectionStatusChanged, onDisconnected, onOrderCompleted, onOrderUpdated, onPositionRemoved, onPositionUpdated, onSymbolPriceUpdated, onSymbolSpecificationUpdated

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

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

reset

public abstract void reset()

Resets the storage

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

getLastHistoryOrderTime

public abstract CompletableFuture<IsoTime> getLastHistoryOrderTime()

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

getLastDealTime

public abstract CompletableFuture<IsoTime> getLastDealTime()

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

onHistoryOrderAdded

public abstract CompletableFuture<Void> onHistoryOrderAdded(MetatraderOrder historyOrder)

Description copied from class: SynchronizationListener

Invoked when a new MetaTrader history order is added

Overrides:

onHistoryOrderAdded in class SynchronizationListener

Parameters:

historyOrder - new MetaTrader history order

Returns:

completable future which resolves when the asynchronous event is processed

onDealAdded

public abstract CompletableFuture<Void> onDealAdded(MetatraderDeal deal)

Description copied from class: SynchronizationListener

Invoked when a new MetaTrader history deal is added

Overrides:

onDealAdded in class SynchronizationListener

Parameters:

deal - new MetaTrader history deal

Returns:

completable future which resolves when the asynchronous event is processed

onDealSynchronizationFinished

public CompletableFuture<Void> onDealSynchronizationFinished(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:

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

onOrderSynchronizationFinished

public CompletableFuture<Void> onOrderSynchronizationFinished(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:

synchronizationId - synchronization request id

Returns:

completable future which resolves when the asynchronous event is processed

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