Package com.inductiveautomation.ignition.gateway.storeforward.sinks

Interface DataSink<T extends PersistentData>

Type Parameters:
T - a subclass of PersistentData
All Superinterfaces:
DataConsumer<T>
All Known Subinterfaces:
DataStore<T>
All Known Implementing Classes:
AbstractDatasourceSink, AbstractSink, HistoricalRecordSink, RemoteHistorianSink, TagHistoryDataSinkBridge
public interface DataSink<T extends PersistentData> extends DataConsumer<T>
This interface represents a data sink that can consume and process data of a particular type.

  • Method Details

    • startup

      default void startup()
      Starts up the data sink.

    • shutdown

      default void shutdown()
      Shuts down the data sink.

    • getInfo

      DataSinkInformation getInfo()
      Returns descriptive information about this data sink.
      Returns:
      the descriptive information pertaining to this data sink

    • isAccepting

      boolean isAccepting()
      Determines whether the data sink is currently accepting data.
      Returns:
      true if the data sink is accepting data, false otherwise

    • getSupportedFlavor

      PersistentFlavor<T> getSupportedFlavor()
      Returns the flavor of data that the data sink supports.
      Returns:
      a PersistentFlavor object representing the supported flavor

    • getWriter

      BatchWriter<T> getWriter()
      Gets a writer object for writing to the data sink. This can be used for batching data together when writing.
      Returns:
      a BatchWriter object for writing to the data sink