cloud.metaapi.sdk.clients.meta_api

Class SubscriptionManager

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SubscriptionManager

public class SubscriptionManager
extends Object

Subscription manager to handle account subscription logic

Constructor Summary

Constructors

Constructor and Description
SubscriptionManager(MetaApiWebsocketClient websocketClient) Constructs the subscription manager

Method Summary

Modifier and Type	Method and Description
void	cancelAccount(String accountId) Cancels active subscription tasks for an account
void	cancelSubscribe(String instanceId) Cancels active subscription tasks for an instance id
boolean	isAccountSubscribing(String accountId, Integer instanceNumber) Returns whether an account is currently subscribing
CompletableFuture<Void>	onDisconnected(String accountId, int instanceNumber) Invoked when connection to MetaTrader terminal terminated
void	onReconnected(int socketInstanceIndex, List<String> reconnectAccountIds) Invoked when connection to MetaApi websocket API restored after a disconnect.
void	onTimeout(String accountId, Integer instanceNumber) Invoked on account timeout.
CompletableFuture<Void>	subscribe(String accountId, Integer instanceNumber, boolean isDisconnectedRetryMode) Schedules to send subscribe requests to an account until cancelled

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionManager

public SubscriptionManager(MetaApiWebsocketClient websocketClient)

Constructs the subscription manager

Parameters:

websocketClient - websocket client to use for sending requests

Method Detail

isAccountSubscribing

public boolean isAccountSubscribing(String accountId,
                                    Integer instanceNumber)

Returns whether an account is currently subscribing

Parameters:

accountId - account id

instanceNumber - instance index number, or null

Returns:

whether an account is currently subscribing

subscribe

public CompletableFuture<Void> subscribe(String accountId,
                                         Integer instanceNumber,
                                         boolean isDisconnectedRetryMode)

Schedules to send subscribe requests to an account until cancelled

Parameters:

accountId - id of the MetaTrader account

instanceNumber - instance index number

isDisconnectedRetryMode - whether to start subscription in disconnected retry mode. Subscription task in disconnected mode will be immediately replaced when the status packet is received

Returns:

completable future when the operation is completed

cancelSubscribe

public void cancelSubscribe(String instanceId)

Cancels active subscription tasks for an instance id

Parameters:

instanceId - instance id to cancel subscription task for

cancelAccount

public void cancelAccount(String accountId)

Cancels active subscription tasks for an account

Parameters:

accountId - account id to cancel subscription tasks for

onTimeout

public void onTimeout(String accountId,
                      Integer instanceNumber)

Invoked on account timeout.

Parameters:

accountId - id of the MetaTrader account

instanceNumber - instance index

onDisconnected

public CompletableFuture<Void> onDisconnected(String accountId,
                                              int instanceNumber)

Invoked when connection to MetaTrader terminal terminated

Parameters:

accountId - id of the MetaTrader account

instanceNumber - instance index number

Returns:

completable future when the operation is completed

onReconnected

public void onReconnected(int socketInstanceIndex,
                          List<String> reconnectAccountIds)

Invoked when connection to MetaApi websocket API restored after a disconnect.

Parameters:

socketInstanceIndex - socket instance index

reconnectAccountIds - account ids to reconnect