Package com.inductiveautomation.historian.gateway.api.storage.realtime

Class DataCollectorFactory.StreamingDataCollector

java.lang.Object

com.inductiveautomation.historian.gateway.api.storage.realtime.DataCollectorFactory.AbstractDataCollector

com.inductiveautomation.historian.gateway.api.storage.realtime.DataCollectorFactory.StreamingDataCollector

All Implemented Interfaces:

DataCollector, Runnable

Enclosing class:

DataCollectorFactory

protected class DataCollectorFactory.StreamingDataCollector
extends DataCollectorFactory.AbstractDataCollector
implements Runnable

Base abstract class for data collector implementations that provides common functionality for both manual and streaming collection modes.

A data collector manages a set of node sessions that produce data points from various sources. It tracks active sessions, handles source changes and retirements, and delegates data collection to the appropriate node sessions based on the collection mode.

The collector coordinates with a SnapshotProcessor to process collected data points during collection operations. It maintains thread-safe collections of active sessions and source changes to ensure data integrity in concurrent environments.

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.historian.gateway.api.storage.realtime.DataCollectorFactory.AbstractDataCollector

DataCollectorFactory.AbstractDataCollector.AbstractNodeSession, DataCollectorFactory.AbstractDataCollector.ManualNodeSession, DataCollectorFactory.AbstractDataCollector.StreamingNodeSession

Constructor Summary

Constructors

Constructor	Description
StreamingDataCollector(Multikey key, StorageEngine storageEngine, CollectorId collectorId, SnapshotProcessor processor)

Method Summary

Modifier and Type	Method	Description
protected void	collectData()
void	run()
CompletionStage<Void>	shutdown()	Initiates an orderly shutdown of this DataCollector.

Methods inherited from class com.inductiveautomation.historian.gateway.api.storage.realtime.DataCollectorFactory.AbstractDataCollector

closeSession, createNodeSession, executeDataCollection, identifier, onSourceChanged

Methods inherited from class java.lang.Object

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

Constructor Details

StreamingDataCollector

public StreamingDataCollector(Multikey key,
 StorageEngine storageEngine,
 CollectorId collectorId,
 SnapshotProcessor processor)

Method Details

run

public void run()

Specified by:

run in interface Runnable

collectData

protected void collectData()

shutdown

public CompletionStage<Void> shutdown()

Description copied from interface: DataCollector

Initiates an orderly shutdown of this DataCollector. This operation will:

1. Stop accepting new data points or node sessions
2. Process and flush any remaining queued data
3. Close all active DataNodeSessions
4. Release any system resources

After calling this method, the DataCollector instance should be considered unusable and any subsequent method calls will result in undefined behavior.

Specified by:

shutdown in interface DataCollector

Overrides:

shutdown in class DataCollectorFactory.AbstractDataCollector

Returns:

A CompletionStage that completes normally when shutdown is finished, or completes exceptionally if errors occurred during shutdown