Package com.inductiveautomation.gateway.tags.history.tsdb.localhistorian

Class LocalHistorianProvider.SyncSFEngineStore

    • Field Summary

      • Fields inherited from class com.inductiveautomation.ignition.gateway.history.DefaultStoreAndForwardEngine

        consumer, dataSink, dataStore, log, shutdown, started, WAIT_TIME

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addDataCountChangeListener​(java.beans.PropertyChangeListener listener)
      Listener will be notified when new data is available for storage.
      int getDataCount()
      Amount of data in the cache available to be forwarded.
      long getOldestTimestamp()
      Gets the timestamp of the oldest data, in order to calculate how long data has been present.
      void removeDataCountChangeListener​(java.beans.PropertyChangeListener listener)  
      TransactionSet takeNext​(boolean wait, int desiredTransactionSize, java.util.Date olderThan)
      Gets the next set of transactions to run.

      • Methods inherited from class com.inductiveautomation.ignition.gateway.history.DefaultStoreAndForwardEngine

        acceptsData, createForwarder, getInfo, getLogger, getPipelineName, getQuarantineManager, getSink, getStore, isAccepting, isLicensedFor, isStarted, setForwardAge, setForwardCount, setForwardSchedule, setPipelineName, setSink, setStore, shutdown, startup, storeData

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SyncSFEngineStore

        public SyncSFEngineStore​(DataStore memory,
                         DataStore local,
                         long forwardAge,
                         int forwardCount)

    • Method Detail

      • addDataCountChangeListener

        public void addDataCountChangeListener​(java.beans.PropertyChangeListener listener)
        Description copied from interface: DataStore
        Listener will be notified when new data is available for storage.
        Specified by:
        addDataCountChangeListener in interface DataStore

      • removeDataCountChangeListener

        public void removeDataCountChangeListener​(java.beans.PropertyChangeListener listener)
        Specified by:
        removeDataCountChangeListener in interface DataStore

      • getDataCount

        public int getDataCount()
        Description copied from interface: DataStore
        Amount of data in the cache available to be forwarded. This value cannot be trusted to be 100% accurate, it could be an estimation, and could return negative values if the cache thinks nothing is available or does not yet know how many points are available.
        Specified by:
        getDataCount in interface DataStore

      • getOldestTimestamp

        public long getOldestTimestamp()
        Description copied from interface: DataStore
        Gets the timestamp of the oldest data, in order to calculate how long data has been present. Does not look at quarantined data. Returns Long.MaxValue if there is no value available (because that will be in the future, and thus not old).
        Specified by:
        getOldestTimestamp in interface DataStore

      • takeNext

        public TransactionSet takeNext​(boolean wait,
                               int desiredTransactionSize,
                               java.util.Date olderThan)
                        throws java.lang.InterruptedException
        Description copied from interface: DataStore
        Gets the next set of transactions to run.
        Specified by:
        takeNext in interface DataStore
        Parameters:
        wait - whether to block until data is available. If false, or if an olderThan parameter is provided, will return null if no data is present.
        desiredTransactionSize - the desired size of data in the transactions. ONLY A HINT! Stores are free to return whatever they think is best. If -1, it's left to the store's discretion (usually will return 1 at a time)
        olderThan - If null, not used. Otherwise only returns data older than the given value. Returns null if there is no old data available.
        Throws:
        java.lang.InterruptedException