com.devexperts.qd.qtp

Class DistributorAdapter

java.lang.Object

com.devexperts.qd.qtp.MessageConsumerAdapter

com.devexperts.qd.qtp.MessageAdapter

com.devexperts.qd.qtp.DistributorAdapter

All Implemented Interfaces:

QDFilter.UpdateListener, MessageAdapterMBean, MessageConsumer, MessageProvider, SymbolCodec.Resolver

public class DistributorAdapter
extends MessageAdapter
implements QDFilter.UpdateListener

The DistributorAdapter adapts distributor side of QD to message API. The distributor side of an QD is an aggregation of QDDistributor for all its APIs (the DistributorAdapter creates its own distributors, one distributor per API). Thus, the DistributorAdapter can be used to represent an outside data provider in the specific QD. if you are a QD client - use this Adapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributorAdapter.Factory The factory for distributor side of a QD.

Nested classes/interfaces inherited from class com.devexperts.qd.qtp.MessageAdapter

MessageAdapter.AbstractFactory, MessageAdapter.CloseListener, MessageAdapter.ConfigurableFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SUPPORTED_MESSAGE_TYPE
static int	MESSAGE_DESCRIBE_PROTOCOL
static int	MESSAGE_DESCRIBE_RECORDS
static int	MESSAGE_DESCRIBE_RESERVED
static int	MESSAGE_GZIP_COMPRESSION This value is reserved and can not be used as any message type.
static int	MESSAGE_HEARTBEAT
static int	MESSAGE_HISTORY_ADD_SUBSCRIPTION
static int	MESSAGE_HISTORY_DATA
static int	MESSAGE_HISTORY_REMOVE_SUBSCRIPTION
static int	MESSAGE_PART
static int	MESSAGE_RAW_DATA
static int	MESSAGE_RMI_ADVERTISE_SERVICES
static int	MESSAGE_RMI_CANCEL
static int	MESSAGE_RMI_DESCRIBE_OPERATION
static int	MESSAGE_RMI_DESCRIBE_SUBJECT
static int	MESSAGE_RMI_ERROR
static int	MESSAGE_RMI_REQUEST
static int	MESSAGE_RMI_RESPONSE
static int	MESSAGE_RMI_RESULT
static int	MESSAGE_STREAM_ADD_SUBSCRIPTION
static int	MESSAGE_STREAM_DATA
static int	MESSAGE_STREAM_REMOVE_SUBSCRIPTION
static int	MESSAGE_TEXT_FORMAT
static int	MESSAGE_TICKER_ADD_SUBSCRIPTION
static int	MESSAGE_TICKER_DATA
static int	MESSAGE_TICKER_REMOVE_SUBSCRIPTION
static int	MESSAGE_ZIP_COMPRESSION This value is reserved and can not be used as any message type.

Fields inherited from class com.devexperts.qd.qtp.MessageAdapter

AUTHENTICATION_LOGIN_REQUIRED, closeListener, doNotCloseOnErrors, messageListener, remoteEndpointId, useDescribeProtocol

Constructor Summary

Constructors

Constructor and Description
DistributorAdapter(QDEndpoint endpoint, QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDFilter stripe, QDStats stats, FieldReplacersCache fieldReplacer)
DistributorAdapter(QDEndpoint endpoint, QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDStats stats) Deprecated.
DistributorAdapter(QDEndpoint endpoint, QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDStats stats, FieldReplacersCache fieldReplacer) Deprecated.
DistributorAdapter(QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDStats stats) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	closeImpl()
protected QDDistributor	createDistributor(QDCollector collector, QDFilter filter, QDFilter stripe, String keyProperties) This method is used internally by distributor adapter to create agent for the corresponding collector, filter, stripe, and keyProperties from this adapter's constructor.
void	filterUpdated(QDFilter filter) This method is fired at most once is a lifetime of a dynamic filter when it updates.
com.devexperts.util.TimePeriodInfo	getAggregationPeriodInfo() Returns the aggregation period info for this adapter (programmatic API).
QDCollector	getCollector(QDContract contract)
FieldReplacersCache	getFieldReplacer() Field Replacers specification.
String	getRequestedAggregationPeriod() Returns the client-requested aggregation period string.
DataScheme	getScheme()
String	getSymbol(char[] chars, int offset, int length) Returns symbol used for specified characters or null if not found.
boolean	isProtocolDescriptorCompatible(ProtocolDescriptor desc)
void	prepareProtocolDescriptor(ProtocolDescriptor desc) Prepares outgoing protocol descriptor.
protected void	processData(DataIterator iterator, MessageType message)
void	processDescribeProtocol(ProtocolDescriptor desc, boolean logDescriptor) Process incoming protocol descriptor.
boolean	retrieveMessages(MessageVisitor visitor) Retrieves accumulated message into specified message visitor.
void	setAggregationPeriodInfo(com.devexperts.util.TimePeriodInfo timePeriodInfo) Updates the server-applied aggregation period info on this adapter.
void	setRequestedAggregationPeriod(String requestedAggregationPeriod) Sets the requested aggregation period to send to the server.
void	setRequestedAggregationPeriod(com.devexperts.util.TimePeriod requestedAggregationPeriod) Sets requested aggregation period (programmatic API, TimePeriod).
protected void	startImpl(MasterMessageAdapter master)
void	subscriptionAvailable(SubscriptionProvider provider)
protected void	subscriptionChanged(SubscriptionProvider provider, MessageType message)
String	toString() Returns description of this MessageAdapter for management and logging purposes.
protected boolean	visitSubscription(MessageVisitor visitor, SubscriptionProvider provider, MessageType message)

Methods inherited from class com.devexperts.qd.qtp.MessageAdapter

addMask, clearMessageMask, close, getAggregationPeriodInfoStr, getCommonScheme, getConnectionVariables, getDefaultAggregationPeriod, getEndpoint, getMaxAggregationPeriod, getMessageMask, getMinAggregationPeriod, getRemoteEndpointId, getRemoteHostAddress, getRemoteOptSet, getStats, getStatus, handleCorruptedMessage, handleCorruptedStream, handleUnknownMessage, hasMessageMask, intersectStripes, isAlive, isClosed, isMarkedForImmediateRestart, markForImmediateRestart, nextRetrieveTime, notifyListener, prepareAuthenticateProtocolDescriptor, processDescribeProtocol, reinitConfiguration, reportIgnoredMessage, retrieveDescribeProtocolMessage, retrieveMask, setAuthRealm, setCloseListener, setConnectionVariables, setDefaultAggregationPeriod, setLoginHandler, setMaxAggregationPeriod, setMessageListener, setMinAggregationPeriod, setRemoteOptSet, start, start, supportsMixedSubscription, useDescribeProtocol

Methods inherited from class com.devexperts.qd.qtp.MessageConsumerAdapter

processHeartbeat, processHistoryAddSubscription, processHistoryData, processHistoryRemoveSubscription, processOtherMessage, processOtherMessage, processRecordSource, processStreamAddSubscription, processStreamData, processStreamRemoveSubscription, processSubscription, processTickerAddSubscription, processTickerData, processTickerRemoveSubscription, processTimeProgressReport

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_HEARTBEAT

public static final int MESSAGE_HEARTBEAT

See Also:

Constant Field Values

MESSAGE_DESCRIBE_PROTOCOL

public static final int MESSAGE_DESCRIBE_PROTOCOL

See Also:

Constant Field Values

MESSAGE_DESCRIBE_RECORDS

public static final int MESSAGE_DESCRIBE_RECORDS

See Also:

Constant Field Values

MESSAGE_DESCRIBE_RESERVED

public static final int MESSAGE_DESCRIBE_RESERVED

See Also:

Constant Field Values

MESSAGE_PART

public static final int MESSAGE_PART

See Also:

Constant Field Values

MESSAGE_RAW_DATA

public static final int MESSAGE_RAW_DATA

See Also:

Constant Field Values

MESSAGE_TICKER_DATA

public static final int MESSAGE_TICKER_DATA

See Also:

Constant Field Values

MESSAGE_TICKER_ADD_SUBSCRIPTION

public static final int MESSAGE_TICKER_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_TICKER_REMOVE_SUBSCRIPTION

public static final int MESSAGE_TICKER_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_STREAM_DATA

public static final int MESSAGE_STREAM_DATA

See Also:

Constant Field Values

MESSAGE_STREAM_ADD_SUBSCRIPTION

public static final int MESSAGE_STREAM_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_STREAM_REMOVE_SUBSCRIPTION

public static final int MESSAGE_STREAM_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_HISTORY_DATA

public static final int MESSAGE_HISTORY_DATA

See Also:

Constant Field Values

MESSAGE_HISTORY_ADD_SUBSCRIPTION

public static final int MESSAGE_HISTORY_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_HISTORY_REMOVE_SUBSCRIPTION

public static final int MESSAGE_HISTORY_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_RMI_ADVERTISE_SERVICES

public static final int MESSAGE_RMI_ADVERTISE_SERVICES

See Also:

Constant Field Values

MESSAGE_RMI_DESCRIBE_SUBJECT

public static final int MESSAGE_RMI_DESCRIBE_SUBJECT

See Also:

Constant Field Values

MESSAGE_RMI_DESCRIBE_OPERATION

public static final int MESSAGE_RMI_DESCRIBE_OPERATION

See Also:

Constant Field Values

MESSAGE_RMI_REQUEST

public static final int MESSAGE_RMI_REQUEST

See Also:

Constant Field Values

MESSAGE_RMI_CANCEL

public static final int MESSAGE_RMI_CANCEL

See Also:

Constant Field Values

MESSAGE_RMI_RESULT

public static final int MESSAGE_RMI_RESULT

See Also:

Constant Field Values

MESSAGE_RMI_ERROR

public static final int MESSAGE_RMI_ERROR

See Also:

Constant Field Values

MESSAGE_RMI_RESPONSE

public static final int MESSAGE_RMI_RESPONSE

See Also:

Constant Field Values

MAX_SUPPORTED_MESSAGE_TYPE

public static final int MAX_SUPPORTED_MESSAGE_TYPE

See Also:

Constant Field Values

MESSAGE_TEXT_FORMAT

public static final int MESSAGE_TEXT_FORMAT

See Also:

Constant Field Values

MESSAGE_ZIP_COMPRESSION

public static final int MESSAGE_ZIP_COMPRESSION

This value is reserved and can not be used as any message type. It is the second byte of zip file compression.

See Also:

Constant Field Values

MESSAGE_GZIP_COMPRESSION

public static final int MESSAGE_GZIP_COMPRESSION

This value is reserved and can not be used as any message type. It is the second byte of gzip file compression.

See Also:

Constant Field Values

Constructor Detail

DistributorAdapter

public DistributorAdapter(QDEndpoint endpoint,
                          QDTicker ticker,
                          QDStream stream,
                          QDHistory history,
                          SubscriptionFilter filter,
                          QDFilter stripe,
                          QDStats stats,
                          FieldReplacersCache fieldReplacer)

DistributorAdapter

@Deprecated
public DistributorAdapter(QDEndpoint endpoint,
                                      QDTicker ticker,
                                      QDStream stream,
                                      QDHistory history,
                                      SubscriptionFilter filter,
                                      QDStats stats,
                                      FieldReplacersCache fieldReplacer)

Deprecated.

DistributorAdapter

@Deprecated
public DistributorAdapter(QDEndpoint endpoint,
                                      QDTicker ticker,
                                      QDStream stream,
                                      QDHistory history,
                                      SubscriptionFilter filter,
                                      QDStats stats)

Deprecated.

DistributorAdapter

@Deprecated
public DistributorAdapter(QDTicker ticker,
                                      QDStream stream,
                                      QDHistory history,
                                      SubscriptionFilter filter,
                                      QDStats stats)

Deprecated.

Method Detail

getRequestedAggregationPeriod

public String getRequestedAggregationPeriod()

Description copied from interface: MessageAdapterMBean

Returns the client-requested aggregation period string. Returns null if not set. Applicable for client-side adapters (DistributorAdapter).

Specified by:

getRequestedAggregationPeriod in interface MessageAdapterMBean

Overrides:

getRequestedAggregationPeriod in class MessageAdapter

setRequestedAggregationPeriod

public void setRequestedAggregationPeriod(String requestedAggregationPeriod)

Description copied from interface: MessageAdapterMBean

Sets the requested aggregation period to send to the server.

Specified by:

setRequestedAggregationPeriod in interface MessageAdapterMBean

Overrides:

setRequestedAggregationPeriod in class MessageAdapter

Parameters:

requestedAggregationPeriod - aggregation period string (e.g. "1s"), or "undefined"/empty to reset

setRequestedAggregationPeriod

public void setRequestedAggregationPeriod(com.devexperts.util.TimePeriod requestedAggregationPeriod)

Sets requested aggregation period (programmatic API, TimePeriod).

setAggregationPeriodInfo

public void setAggregationPeriodInfo(com.devexperts.util.TimePeriodInfo timePeriodInfo)

Description copied from class: MessageAdapter

Updates the server-applied aggregation period info on this adapter. Default no-op; DistributorAdapter overrides with the real assignment, and wrapper adapters (e.g. RMIMessageAdapter) override to forward to their attached adapter.

Overrides:

setAggregationPeriodInfo in class MessageAdapter

getAggregationPeriodInfo

public com.devexperts.util.TimePeriodInfo getAggregationPeriodInfo()

Description copied from class: MessageAdapter

Returns the aggregation period info for this adapter (programmatic API). For AgentAdapter: computed from actual channel shaper values. For DistributorAdapter: received from server.

Overrides:

getAggregationPeriodInfo in class MessageAdapter

Returns:

aggregation period info, or TimePeriodInfo.UNKNOWN if not available

getCollector

public QDCollector getCollector(QDContract contract)

createDistributor

protected QDDistributor createDistributor(QDCollector collector,
                                          QDFilter filter,
                                          QDFilter stripe,
                                          String keyProperties)

This method is used internally by distributor adapter to create agent for the corresponding collector, filter, stripe, and keyProperties from this adapter's constructor. This method may be overridden to create agent with other filter, otherwise customize the agent that is being created, or to keep track of created agents.

toString

public String toString()

Description copied from class: MessageAdapter

Returns description of this MessageAdapter for management and logging purposes.

Overrides:

toString in class MessageAdapter

getScheme

public DataScheme getScheme()

Specified by:

getScheme in class MessageAdapter

getSymbol

public String getSymbol(char[] chars,
                        int offset,
                        int length)

Description copied from class: MessageConsumerAdapter

Returns symbol used for specified characters or null if not found.

Specified by:

getSymbol in interface SymbolCodec.Resolver

Overrides:

getSymbol in class MessageConsumerAdapter

getFieldReplacer

public FieldReplacersCache getFieldReplacer()

Description copied from class: MessageAdapter

Field Replacers specification.

Overrides:

getFieldReplacer in class MessageAdapter

filterUpdated

public void filterUpdated(QDFilter filter)

Description copied from interface: QDFilter.UpdateListener

This method is fired at most once is a lifetime of a dynamic filter when it updates. The new value of the filter shall be retrieved with QDFilter.getUpdatedFilter() method. This method is never called under synchronization on any filter to avoid deadlocks.

Specified by:

filterUpdated in interface QDFilter.UpdateListener

Parameters:

filter - The filter that was updated. Use filter.getUpdateFilter() to get the new instance of the updated filter.

startImpl

protected void startImpl(MasterMessageAdapter master)

Overrides:

startImpl in class MessageAdapter

closeImpl

protected void closeImpl()

Overrides:

closeImpl in class MessageAdapter

processData

protected void processData(DataIterator iterator,
                           MessageType message)

Overrides:

processData in class MessageConsumerAdapter

retrieveMessages

public boolean retrieveMessages(MessageVisitor visitor)

Description copied from interface: MessageProvider

Retrieves accumulated message into specified message visitor. Returns true if some messages still remains in the provider or false if all accumulated messages were retrieved.

Specified by:

retrieveMessages in interface MessageProvider

Overrides:

retrieveMessages in class MessageAdapter

prepareProtocolDescriptor

public void prepareProtocolDescriptor(ProtocolDescriptor desc)

Description copied from class: MessageAdapter

Prepares outgoing protocol descriptor. Implementers should call super.prepareProtocolDescriptor(desc).

Overrides:

prepareProtocolDescriptor in class MessageAdapter

Parameters:

desc - outgoing protocol descriptor

processDescribeProtocol

public void processDescribeProtocol(ProtocolDescriptor desc,
                                    boolean logDescriptor)

Description copied from class: MessageAdapter

Process incoming protocol descriptor. Implementers should call super.processDescribeProtocol(desc).

Specified by:

processDescribeProtocol in interface MessageConsumer

Overrides:

processDescribeProtocol in class MessageAdapter

Parameters:

desc - incoming protocol descriptor

logDescriptor - when protocol description shall be logged.

isProtocolDescriptorCompatible

public boolean isProtocolDescriptorCompatible(ProtocolDescriptor desc)

Overrides:

isProtocolDescriptorCompatible in class MessageAdapter

visitSubscription

protected boolean visitSubscription(MessageVisitor visitor,
                                    SubscriptionProvider provider,
                                    MessageType message)

subscriptionAvailable

public void subscriptionAvailable(SubscriptionProvider provider)

subscriptionChanged

protected void subscriptionChanged(SubscriptionProvider provider,
                                   MessageType message)