Package velox.api.layer1.messages

Class TradingAccountsInfoMessage

java.lang.Object

velox.api.layer1.messages.TradingAccountsInfoMessage

public final class TradingAccountsInfoMessage
extends Object

Message containing an account info for one of the accounts of the instrument. Each instrument can have multiple accounts, so this message can be sent multiple times for the same instrument.

This message should be sent by the provider (if any trading accounts are available) for each instrument alias the provider has subscription for, using Layer1ApiAdminListener.onUserMessage(Object).

If provider receives TradingOnlySubscribe message, it should send TradingAccountsInfoMessage in response for the instrument if it supports multi-account trading.

This message can be received by the strategy in Layer1ApiAdminListener.onUserMessage(Object).
To handle this message you can use AccountListManager to track any account information.
You can also handle this message by yourself, if you don't want to use AccountListManager.

See Also:

• Layer1MultiAccountTradingSupported
• Layer1ApiTradingListener

Field Summary

Fields

Modifier and Type	Field	Description
final AccountInfo	accountInfo	Account info for the account of the instrument.
final String	alias	Alias of the instrument the account relates to.
final boolean	isAdd	If true, account information for the instrument has just been added, if false - account is no longer available.

Constructor Summary

Constructors

Constructor	Description
TradingAccountsInfoMessage(String alias, AccountInfo accountInfo, boolean isAdd)

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

alias

public final String alias

Alias of the instrument the account relates to.

Alias should be null (with isAdd=true) to notify about account information for the provider before any instrument is subscribed, if such information is available before the subscription to any instrument (i.e. just connected to the provider).

If a message was previously sent with alias = null and isAdd = true before any instrument subscription, a message with alias = null and isAdd = false should be sent when disconnecting from the provider to indicate the removal of account information.

Sending a message with alias = null and isAdd = false will remove the account information for the provider (for all aliases). This message can be sent to remove account information even if no prior message with alias = null and isAdd = true was sent during the connection.

On provider disconnect, the provider should remove all account information for all aliases. This can be achieved by sending messages with alias = null and isAdd = false to remove accounts for all aliases, as described above.

When unsubscribing from a single instrument, the provider should remove the account information only for that specific instrument by specifying the specific alias of the instrument in this message.

accountInfo

public final AccountInfo accountInfo

Account info for the account of the instrument.

isAdd

public final boolean isAdd

If true, account information for the instrument has just been added, if false - account is no longer available.

Constructor Details

TradingAccountsInfoMessage

public TradingAccountsInfoMessage(String alias,
 AccountInfo accountInfo,
 boolean isAdd)

Parameters:

alias - alias of the instrument the account relates to. Can be null to notify about account information before any instrument is subscribed.

accountInfo - account info for the account of the instrument

isAdd - if true, account information for the instrument has just been added, if false - account is no longer available

Method Details

toString

public String toString()

Overrides:

toString in class Object