Click or drag to resize

IaonSession Class

Represents a new Input, Action, Output interface session.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersIaonSession

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntax
public class IaonSession : IProvideStatus, 
	IDisposable
View Source

The IaonSession type exposes the following members.

Constructors
 NameDescription
Public methodIaonSession Creates a new IaonSession.
Top
Properties
 NameDescription
Public propertyActionAdapters Gets the action adapter collection for this IaonSession.
Public propertyAllAdapters Gets the all adapters collection for this IaonSession.
Public propertyDataSource Gets or sets the configuration DataSet for this IaonSession.
Public propertyFilterAdapters Gets the filter adapter collection for this IaonSession.
Public propertyInputAdapters Gets the input adapter collection for this IaonSession.
Public propertyInputMeasurementKeysRestriction Gets or sets a routing table restriction for a collection of input measurement keys.
Public propertyName Gets name assigned to this IaonSession, if any.
Public propertyNodeID Gets or sets the Guid node ID for this IaonSession.
Public propertyOutputAdapters Gets the output adapter collection for this IaonSession.
Public propertyRoutingTables Gets the routing tables for this IaonSession.
Public propertyStatus Gets the combined status of the adapters in this IaonSession.
Top
Methods
 NameDescription
Public methodConfigurationChangedHandler Event handler for adapter notifications about configuration changes.
Public methodDispose Releases all the resources used by the IaonSession object.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the IaonSession object and optionally releases the managed resources.
Public methodDisposedHandler Event handler for disposed events from all adapters.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodStatic memberExtractTemporalConfiguration Extracts a configuration that supports temporal processing from an existing real-time configuration.
Protected methodFinalize Releases the unmanaged resources before the IaonSession object is reclaimed by GC.
(Overrides ObjectFinalize)
Public methodGetDerivedName Gets derived name of specified object.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitialize Initialize and start adapters.
Public methodInputMeasurementKeysUpdatedHandler Event handler for updates to adapter input measurement key definitions.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNewMeasurementsHandler Event handler for new measurement notifications from input adapters and action adapters.
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
Protected methodOnDisposed Raises the Disposed event.
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
Protected methodOnProcessException Raises ProcessException event.
Protected methodOnProcessingComplete Raises the ProcessingComplete event.
Protected methodOnStatusMessage(Object, String, UpdateType) Raises the StatusMessage event.
Protected methodOnStatusMessage(Object, String, UpdateType, Object) Raises the StatusMessage event with a formatted status message.
Protected methodOnUnprocessedMeasurements Raises the UnprocessedMeasurements event.
Protected methodOnUnpublishedSamples Raises the UnpublishedSamples event.
Public methodOutputMeasurementsUpdatedHandler Event handler for updates to adapter output measurement definitions.
Public methodProcessExceptionHandler Event handler for processing reported exceptions.
Public methodProcessingCompleteHandler Event handler for processing complete notifications from input adapters.
Public methodRecalculateRoutingTables Recalculates routing tables as long as all adapters have been initialized.
Public methodRequestTemporalSupportHandler Event handler for requesting temporal support.
Public methodStatusMessageHandler Event handler for reporting status messages.
Public methodTemporalProcessingSupportExists Gets flag that determines if temporal processing is supported in this IaonSession.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUnprocessedMeasurementsHandler Event handler for monitoring unprocessed measurements.
Public methodUnpublishedSamplesHandler Event handler for monitoring unpublished samples.
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
Public eventDisposed Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed.
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
Public eventProcessException Event is raised when there is an exception encountered while processing.
Public eventProcessingComplete Indicates to the host that processing for one of the input adapters has completed.
Public eventStatusMessage Provides status messages to consumer.
Public eventUnprocessedMeasurements Event is raised every five seconds allowing host to track total number of unprocessed measurements.
Public eventUnpublishedSamples Event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also