com.devexperts.qd

Interface QDCollector

All Superinterfaces:

QDStatsContainer, SubscriptionContainer

All Known Subinterfaces:

QDHistory, QDStream, QDTicker

public interface QDCollector
extends SubscriptionContainer, QDStatsContainer

The QDCollector represents a hub which collects subscription from data consumers and distributes it among data providers and at the same time it collects data from data providers and distributes it among data consumers. The data consumers are represented by their QDAgent, and the data providers are represented by their QDDistributor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	QDCollector.Builder<T extends QDCollector> Builder for collectors.
static interface	QDCollector.Factory Factory for QDCollector instances.

Method Summary

Modifier and Type	Method and Description
QDAgent.Builder	agentBuilder() Returns a builder that can be configured to build custom agents.
QDAgent	buildAgent(QDAgent.Builder builder) Creates new agent with parameters from the specified builder.
QDDistributor	buildDistributor(QDDistributor.Builder builder) Creates new distributor with parameters from the specified builder.
void	close() Closes this collector and frees all external resources that are associated with it.
QDAgent	createAgent(SubscriptionFilter filter) Deprecated. Use agentBuilder and build
QDAgent	createAgent(SubscriptionFilter filter, String keyProperties) Deprecated. Use agentBuilder and build
QDDistributor	createDistributor(SubscriptionFilter filter) Deprecated. Use distributorBuilder and build
QDDistributor	createDistributor(SubscriptionFilter filter, String keyProperties) Deprecated. Use distributorBuilder and build
QDDistributor.Builder	distributorBuilder() Returns a builder that can be configured to build custom distributors.
boolean	examineData(DataVisitor visitor) Deprecated. Use examineData(RecordSink).
boolean	examineData(RecordSink sink) Examines all stored data via specified record sink.
boolean	examineDataBySubscription(RecordSink sink, RecordSource sub) Examines all stored data for a given subscription via specified sink.
void	executeLockBoundTask(Executor executor, Runnable task) Cooperative mechanism to execute a task that spends most of its time under the global lock of this collector (like add/remove/set subscription or closing of agent).
QDContract	getContract() Returns contract that this collector provides.
DataScheme	getScheme() Returns data scheme used by this QD component.
SymbolStriper	getStriper() Returns symbol striper for this QD component.
String	getSymbol(char[] chars, int offset, int length)
boolean	hasEventTimeSequence() Returns true if collector should process event time sequence, false otherwise.
boolean	isStoreEverything() Returns status of "store everything" mode.
void	remove(RecordSource source) Removes the corresponding records from the underlying storage.
void	setErrorHandler(QDErrorHandler errorHandler) Sets errors handler for all errors that are happening during notification of agents and distributors.
void	setStoreEverything(boolean storeEverything) Sets "store everything" mode (disabled by default).
void	setStoreEverythingFilter(SubscriptionFilter filter) Sets filter that is used for "store everything" mode.

Methods inherited from interface com.devexperts.qd.SubscriptionContainer

examineSubscription, examineSubscription, getSubscriptionSize, isSubscribed

Methods inherited from interface com.devexperts.qd.stats.QDStatsContainer

getStats

Method Detail

getScheme

DataScheme getScheme()

Returns data scheme used by this QD component.

getContract

QDContract getContract()

Returns contract that this collector provides.

getStriper

SymbolStriper getStriper()

Returns symbol striper for this QD component.

agentBuilder

QDAgent.Builder agentBuilder()

Returns a builder that can be configured to build custom agents.

buildAgent

QDAgent buildAgent(QDAgent.Builder builder)

Creates new agent with parameters from the specified builder.

Parameters:

builder - parameters.

createAgent

QDAgent createAgent(SubscriptionFilter filter)

Deprecated. Use agentBuilder and build

Creates new agent with the specified subscription filter. Specify null to use no filter. This is a shortcut for

    agentBuilder()
        .withFilter(QDFilter.fromFilter(filter))
        .build();
 

createAgent

QDAgent createAgent(SubscriptionFilter filter,
                    String keyProperties)

Deprecated. Use agentBuilder and build

Creates new agent with the specified subscription filter and key properties. Specify null to use no filter. This is a shortcut for

    agentBuilder()
        .withFilter(QDFilter.fromFilter(filter))
        .withKeyProperties(keyProperties)
        .build();
 

distributorBuilder

QDDistributor.Builder distributorBuilder()

Returns a builder that can be configured to build custom distributors.

buildDistributor

QDDistributor buildDistributor(QDDistributor.Builder builder)

Creates new distributor with parameters from the specified builder.

Parameters:

builder - parameters.

createDistributor

QDDistributor createDistributor(SubscriptionFilter filter)

Deprecated. Use distributorBuilder and build

Creates new distributor with the specified subscription filter. Specify null to use no filter. This is a shortcut for

    distributorBuilder()
        .withFilter(QDFilter.fromFilter(filter))
        .build();
 

createDistributor

QDDistributor createDistributor(SubscriptionFilter filter,
                                String keyProperties)

Deprecated. Use distributorBuilder and build

Creates new distributor with the specified subscription filter and key properties. Specify null to use no filter. This is a shortcut for

    distributorBuilder()
        .withFilter(QDFilter.fromFilter(filter))
        .withKeyProperties(keyProperties)
        .build();
 

setErrorHandler

void setErrorHandler(QDErrorHandler errorHandler)

Sets errors handler for all errors that are happening during notification of agents and distributors. Default error handler for collector is initialized via DataScheme.getService(java.lang.Class<T>) method and QDErrorHandler.DEFAULT is used if no override is found.

isStoreEverything

boolean isStoreEverything()

Returns status of "store everything" mode.

See Also:

setStoreEverything(boolean)

setStoreEverything

void setStoreEverything(boolean storeEverything)

Sets "store everything" mode (disabled by default). In this mode processData stores everything into underlying storage regardless of subscription (by default only records that are subscribed on are being stored). When subscription is removed records are not removed from storage (by default they are). Only records that match specified filter are subject to this mode (all records by default).

Support of the feature depends on collector implementation.

setStoreEverythingFilter

void setStoreEverythingFilter(SubscriptionFilter filter)

Sets filter that is used for "store everything" mode. Use null (default) to turn off filtering and store all records when "store everything" mode is on.

Support of the feature depends on collector implementation.

See Also:

setStoreEverything(boolean)

getSymbol

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

hasEventTimeSequence

boolean hasEventTimeSequence()

Returns true if collector should process event time sequence, false otherwise.

examineData

boolean examineData(DataVisitor visitor)

Deprecated. Use examineData(RecordSink).

Examines all stored data via specified data visitor. Returns true if some data was not examined or false if everything was examined.

examineData

boolean examineData(RecordSink sink)

Examines all stored data via specified record sink. This method periodically calls RecordSink.flush method outside of locks. Returns true if some data was not examined because sink ran out of capacity or false if everything was examined.

In QDHistory collector, this method method uses SNAPSHOT_BEGIN, SNAPSHOT_END, SNAPSHOT_SNIP, REMOVE_EVENT, and TX_PENDING flags appropriately to describe the snapshot and transaction state of stored data, as if the fresh subscription with history snapshot was created.

examineDataBySubscription

boolean examineDataBySubscription(RecordSink sink,
                                  RecordSource sub)

Examines all stored data for a given subscription via specified sink. This method periodically calls RecordSink.flush method outside of locks. Returns true if some data was not examined because sink ran out of capacity or false if everything was examined.

In QDHistory collector, this method method uses SNAPSHOT_BEGIN, SNAPSHOT_END, SNAPSHOT_SNIP, REMOVE_EVENT, and TX_PENDING flags appropriately to describe the snapshot and transaction state of stored data, as if the fresh subscription with history snapshot was created.

Parameters:

sink - the sink to append data to.

sub - the subscription source.

remove

void remove(RecordSource source)

Removes the corresponding records from the underlying storage. Removal is performed under the global lock. This method is designed to facilitate cleanup of stale data in storeEverything mode.

executeLockBoundTask

void executeLockBoundTask(Executor executor,
                          Runnable task)

Cooperative mechanism to execute a task that spends most of its time under the global lock of this collector (like add/remove/set subscription or closing of agent). It adds a task to an internal queue to ensure that at most one such task attempt to run at any given time.

Parameters:

executor - the executor for the task.

task - the runnable task.

close

void close()

Closes this collector and frees all external resources that are associated with it. This method unregisters all monitoring beans that were created for this collector.