com.devexperts.qd.qtp

Interface AgentChannels.Owner

Enclosing class:

AgentChannels

public static interface AgentChannels.Owner

The Owner interface represents the owner of the agent channels. The agent inside the channel will notify the channel owner by calling the recordsAvailable() method. Other methods are necessary for creating and configuring the agent inside the channel.

Method Summary

Modifier and Type	Method and Description
QDAgent	createAgent(QDCollector collector, QDFilter filter) This method is used internally by agent adapter to create agent for the corresponding collector, filter when the corresponding subscription arrives for a first time.
QDAgent	createVoidAgent(QDContract contract) This method is used to create void agent just to keep subscription.
QDFilter	getPeerFilter(QDContract contract) When the channel configuration is updated, it will be summarized by logical AND with the filter that is specified in shaper.
void	recordsAvailable() Notifies the owner when records are available.
boolean	retrieveData(DataProvider dataProvider, QDContract contract) Retrieves accumulated data from data provider.

Method Detail

createAgent

QDAgent createAgent(QDCollector collector,
                    QDFilter filter)

This method is used internally by agent adapter to create agent for the corresponding collector, filter when the corresponding subscription arrives for a first time. This method is called while holding this adapter's lock. This implementation returns collector.createAgent(filter, keyProperties). This method may be overriden to create agent with other filter, otherwise customize the agent that is being created, or to keep track of created agents.

Parameters:

collector - collector to create agent for

filter - subscription filter for the agent

Returns:

newly created agent

createVoidAgent

QDAgent createVoidAgent(QDContract contract)

This method is used to create void agent just to keep subscription.

Parameters:

contract - contract to create agent for

Returns:

newly created agent

getPeerFilter

QDFilter getPeerFilter(QDContract contract)

When the channel configuration is updated, it will be summarized by logical AND with the filter that is specified in shaper.

Parameters:

contract - - contract specified in the shaper

Returns:

filter to be added to the filter that is specified in shaper

recordsAvailable

void recordsAvailable()

Notifies the owner when records are available.

This method is called by AgentChannel to notify the owner that records are available. It is important to note that AgentChannel is designed not to call this method unnecessarily. If it is called, it expects that the data will be retrieved from the collector using the AgentChannels.retrieveData() method.

If the aggregationPeriod is set, this method will be called only the first time. Subsequently, you must manually calculate the next retrieval time using AgentChannels.nextRetrieveTime(long) after each data retrieval. If there has been no data available for an extended period, AgentChannels.nextRetrieveTime(long) will return Long.MAX_VALUE, indicating that you must wait for the recordsAvailable notification to occur again.

retrieveData

boolean retrieveData(DataProvider dataProvider,
                     QDContract contract)

Retrieves accumulated data from data provider. Returns true if some data still remains in the provider or false if all accumulated data were retrieved.