Class ErroredNodeSession
java.lang.Object
com.inductiveautomation.historian.gateway.api.storage.realtime.ErroredNodeSession
- All Implemented Interfaces:
DataNodeSession, Diagnosable
-
Nested Class Summary
Nested classes/interfaces inherited from interface DataNodeSession
DataNodeSession.AvailabilityStatus -
Constructor Summary
ConstructorsConstructorDescriptionErroredNodeSession(QualityCode errorCode) ErroredNodeSession(String message) -
Method Summary
Modifier and TypeMethodDescriptionbooleanattachObserver(NodeSessionObserver observer) Attaches an observer of the session's state and events.booleandetachObserver(NodeSessionObserver observer) Detaches an observer.Returns the node's current availability status.processDataChange(DataPoint<?> dataPoint) Applies a data change to the node.processMetadataChange(MetadataPoint metadata) Applies a metadata change to the node.processSourceChange(SourceChangePoint sourceChange) Applies a source change to the node.voidrelease()Releases the session's resources.reset()Resets the session to its initial state, clearing any cached data.Retires the node: no further data changes are expected, and the caller then callsDataNodeSession.release().voidsampleDiagnostics(DiagnosticsSample sample) Provides the sample upon which the object can set diagnostics information.
-
Constructor Details
-
ErroredNodeSession
-
ErroredNodeSession
-
-
Method Details
-
getAvailabilityStatus
Description copied from interface:DataNodeSessionReturns the node's current availability status.- Specified by:
getAvailabilityStatusin interfaceDataNodeSession
-
processDataChange
Description copied from interface:DataNodeSessionApplies a data change to the node.- Specified by:
processDataChangein interfaceDataNodeSession- Parameters:
dataPoint- the data change- Returns:
- the quality of the operation
-
processSourceChange
Description copied from interface:DataNodeSessionApplies a source change to the node.- Specified by:
processSourceChangein interfaceDataNodeSession- Parameters:
sourceChange- the source change- Returns:
- the quality of the operation
-
processMetadataChange
Description copied from interface:DataNodeSessionApplies a metadata change to the node.- Specified by:
processMetadataChangein interfaceDataNodeSession- Parameters:
metadata- the metadata change- Returns:
- the quality of the operation
-
reset
Description copied from interface:DataNodeSessionResets the session to its initial state, clearing any cached data.- Specified by:
resetin interfaceDataNodeSession- Returns:
- the quality of the operation
-
retireNode
Description copied from interface:DataNodeSessionRetires the node: no further data changes are expected, and the caller then callsDataNodeSession.release().- Specified by:
retireNodein interfaceDataNodeSession- Returns:
- the quality of the operation
-
release
public void release()Description copied from interface:DataNodeSessionReleases the session's resources. Call it afterDataNodeSession.retireNode().- Specified by:
releasein interfaceDataNodeSession
-
attachObserver
Description copied from interface:DataNodeSessionAttaches an observer of the session's state and events.- Specified by:
attachObserverin interfaceDataNodeSession- Parameters:
observer- the observer to attach- Returns:
trueif attached,falseif already attached or attachment failed
-
detachObserver
Description copied from interface:DataNodeSessionDetaches an observer.- Specified by:
detachObserverin interfaceDataNodeSession- Parameters:
observer- the observer to detach- Returns:
trueif detached,falseif not attached or detachment failed
-
sampleDiagnostics
Description copied from interface:DiagnosableProvides the sample upon which the object can set diagnostics information. It is expected that the calling object will first callgetSubSample()in order to specify a useful identifier for this object's data.- Specified by:
sampleDiagnosticsin interfaceDiagnosable
-