Package velox.api.layer1.messages

Class Layer1ApiGetUiValueMessage<T extends Layer1ApiGetUiValueMessage.UiState>

java.lang.Object

velox.api.layer1.messages.Layer1ApiGetUiValueMessage<T>

Type Parameters:

T - the type of the state snapshot delivered to the consumer callback

All Implemented Interfaces:

Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

Direct Known Subclasses:

Layer1ApiGetBracketsMessage, Layer1ApiGetCrossTradingRoundingMessage, Layer1ApiGetCrossTradingTargetMessage, Layer1ApiGetOcoMessage, Layer1ApiGetOrderDurationMessage, Layer1ApiGetOrderSizeMessage, Layer1ApiGetResetOrderSizeCheckboxMessage, Layer1ApiGetStopOrderDurationMessage, Layer1ApiGetStopOrderOffsetMessage, Layer1ApiGetStopOrderTypeMessage, Layer1ApiGetTrailingStopMessage

public abstract sealed class Layer1ApiGetUiValueMessage<T extends Layer1ApiGetUiValueMessage.UiState>
extends Object
implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer
permits Layer1ApiGetBracketsMessage, Layer1ApiGetOcoMessage, Layer1ApiGetTrailingStopMessage, Layer1ApiGetOrderSizeMessage, Layer1ApiGetOrderDurationMessage, Layer1ApiGetStopOrderTypeMessage, Layer1ApiGetStopOrderOffsetMessage, Layer1ApiGetStopOrderDurationMessage, Layer1ApiGetResetOrderSizeCheckboxMessage, Layer1ApiGetCrossTradingTargetMessage, Layer1ApiGetCrossTradingRoundingMessage

Base type for the "get current value" messages that read a single control from the Trading Control Panel.
Send via Layer1ApiAdminProvider.sendUserMessage(Object)

Each subclass targets one Trading Control Panel control and delivers its current value to the supplied consumer as a Layer1ApiGetUiValueMessage.UiState snapshot.

Works only when the Trading Control Panel is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Layer1ApiGetUiValueMessage.UiState	Marker interface for the immutable state snapshots returned by the Layer1ApiGetUiValueMessage subclasses.

Field Summary

Fields

Modifier and Type	Field	Description
final String	alias	The instrument alias the request targets.
final Consumer<T>	consumer	Callback that will receive the current Trading Control Panel state.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Layer1ApiGetUiValueMessage(String alias, Consumer<T> consumer)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

alias

public final String alias

The instrument alias the request targets.

consumer

public final Consumer<T extends Layer1ApiGetUiValueMessage.UiState> consumer

Callback that will receive the current Trading Control Panel state.

Constructor Details

Layer1ApiGetUiValueMessage

protected Layer1ApiGetUiValueMessage(String alias,
 Consumer<T> consumer)

Parameters:

alias - the instrument alias

consumer - callback that will receive the current Trading Control Panel state