C# Class GSF.TimeSeries.Adapters.InputAdapterBase

Represents the base class for any incoming input adapter.
Derived classes are expected to call OnNewMeasurements when new measurements are received.
Inheritance: AdapterBase, IInputAdapter
Afficher le fichier Open project: GridProtectionAlliance/gsf

Méthodes publiques

Méthode Description
Initialize ( ) : void

Initializes InputAdapterBase.
Start ( ) : void

Starts this InputAdapterBase and initiates connection cycle to data input source.
Stop ( ) : void

Stops this InputAdapterBase and disconnects from data input source.

Méthodes protégées

Méthode Description
AttemptConnection ( ) : void

Attempts to connect to data input source.

Derived classes should attempt connection to data input source here. Any exceptions thrown by this implementation will result in restart of the connection cycle.

AttemptDisconnection ( ) : void

Attempts to disconnect from data input source.

Derived classes should attempt disconnect from data input source here. Any exceptions thrown by this implementation will be reported to host via AdapterBase.ProcessException event.

Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the InputAdapterBase object and optionally releases the managed resources.
InputAdapterBase ( ) : System

Constructs a new instance of the InputAdapterBase.
OnConnected ( ) : void

Called when data input source connection is established.

Derived classes should call this method manually if UseAsyncConnect is true.

OnDisconnected ( ) : void

Called when data input source is disconnected.

Derived classes should call this method manually if UseAsyncConnect is true.

OnNewMeasurements ( ICollection measurements ) : void

Raises the NewMeasurements event.
OnProcessingComplete ( ) : void

Raises the ProcessingComplete event.

Private Methods

Méthode Description
AttemptConnectionOperation ( ) : void
m_connectionTimer_Elapsed ( object sender, EventArgs e ) : void

Method Details

AttemptConnection() protected abstract méthode

Attempts to connect to data input source.
Derived classes should attempt connection to data input source here. Any exceptions thrown by this implementation will result in restart of the connection cycle.
protected abstract AttemptConnection ( ) : void
Résultat void

AttemptDisconnection() protected abstract méthode

Attempts to disconnect from data input source.
Derived classes should attempt disconnect from data input source here. Any exceptions thrown by this implementation will be reported to host via AdapterBase.ProcessException event.
protected abstract AttemptDisconnection ( ) : void
Résultat void

Dispose() protected méthode

Releases the unmanaged resources used by the InputAdapterBase object and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
Résultat void

Initialize() public méthode

Initializes InputAdapterBase.
public Initialize ( ) : void
Résultat void

InputAdapterBase() protected méthode

Constructs a new instance of the InputAdapterBase.
protected InputAdapterBase ( ) : System
Résultat System

OnConnected() protected méthode

Called when data input source connection is established.
Derived classes should call this method manually if UseAsyncConnect is true.
protected OnConnected ( ) : void
Résultat void

OnDisconnected() protected méthode

Called when data input source is disconnected.
Derived classes should call this method manually if UseAsyncConnect is true.
protected OnDisconnected ( ) : void
Résultat void

OnNewMeasurements() protected méthode

Raises the NewMeasurements event.
protected OnNewMeasurements ( ICollection measurements ) : void
measurements ICollection
Résultat void

OnProcessingComplete() protected méthode

Raises the ProcessingComplete event.
protected OnProcessingComplete ( ) : void
Résultat void

Start() public méthode

Starts this InputAdapterBase and initiates connection cycle to data input source.
public Start ( ) : void
Résultat void

Stop() public méthode

Stops this InputAdapterBase and disconnects from data input source.
public Stop ( ) : void
Résultat void