cloud.metaapi.sdk.clients.meta_api

Class SynchronizationThrottler

java.lang.Object

cloud.metaapi.sdk.clients.meta_api.SynchronizationThrottler

public class SynchronizationThrottler
extends Object

Synchronization throttler used to limit the amount of concurrent synchronizations to prevent application from being overloaded due to excessive number of synchronisation responses being sent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynchronizationThrottler.Options Options for synchronization throttler

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Long>	synchronizationIds

Constructor Summary

Constructors

Constructor and Description
SynchronizationThrottler(MetaApiWebsocketClient client, int socketInstanceIndex, SynchronizationThrottler.Options opts) Constructs the synchronization throttler

Method Summary

Modifier and Type	Method and Description
List<String>	getActiveSynchronizationIds() Returns the list of currenly active synchronization ids
int	getMaxConcurrentSynchronizations() Returns the amount of maximum allowed concurrent synchronizations
List<String>	getSynchronizingAccounts() Returns the list of currently synchronizing account ids
boolean	isSynchronizationAvailable() Returns flag whether there are free slots for synchronization requests
void	onDisconnect() Clears synchronization ids on disconnect
void	removeIdByParameters(String accountId, int instanceIndex, String host) Removes synchronizations from queue and from the list by parameters
void	removeSynchronizationId(String synchronizationId) Removes synchronization id from slots and removes ids for the same account from the queue
CompletableFuture<Boolean>	scheduleSynchronize(String accountId, com.fasterxml.jackson.databind.node.ObjectNode request) Schedules to send a synchronization request for account
void	updateSynchronizationId(String synchronizationId) Fills a synchronization slot with synchronization id

Methods inherited from class java.lang.Object

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

Field Detail

synchronizationIds

protected Map<String,Long> synchronizationIds

Constructor Detail

SynchronizationThrottler

public SynchronizationThrottler(MetaApiWebsocketClient client,
                                int socketInstanceIndex,
                                SynchronizationThrottler.Options opts)
                         throws cloud.metaapi.sdk.clients.error_handler.ValidationException

Constructs the synchronization throttler

Parameters:

client - MetaApi websocket client

socketInstanceIndex - index of socket instance that uses the throttler

opts - Synchronization throttler options

Throws:

cloud.metaapi.sdk.clients.error_handler.ValidationException - if specified options are invalid

Method Detail

updateSynchronizationId

public void updateSynchronizationId(String synchronizationId)

Fills a synchronization slot with synchronization id

Parameters:

synchronizationId - Synchronization id

getSynchronizingAccounts

public List<String> getSynchronizingAccounts()

Returns the list of currently synchronizing account ids

Returns:

the list of currently synchronizing account ids

getActiveSynchronizationIds

public List<String> getActiveSynchronizationIds()

Returns the list of currenly active synchronization ids

Returns:

Synchronization ids

getMaxConcurrentSynchronizations

public int getMaxConcurrentSynchronizations()

Returns the amount of maximum allowed concurrent synchronizations

Returns:

maximum allowed concurrent synchronizations

isSynchronizationAvailable

public boolean isSynchronizationAvailable()

Returns flag whether there are free slots for synchronization requests

Returns:

Flag whether there are free slots for synchronization requests

removeIdByParameters

public void removeIdByParameters(String accountId,
                                 int instanceIndex,
                                 String host)

Removes synchronizations from queue and from the list by parameters

Parameters:

accountId - account id

instanceIndex - account instance index

host - account host name

removeSynchronizationId

public void removeSynchronizationId(String synchronizationId)

Removes synchronization id from slots and removes ids for the same account from the queue

Parameters:

synchronizationId - Synchronization id

onDisconnect

public void onDisconnect()

Clears synchronization ids on disconnect

scheduleSynchronize

public CompletableFuture<Boolean> scheduleSynchronize(String accountId,
                                                      com.fasterxml.jackson.databind.node.ObjectNode request)

Schedules to send a synchronization request for account

Parameters:

accountId - Account id

request - Request to send

Returns:

Completable future resolving when synchronization is scheduled