C# Class GSF.Historian.DataListener

Inheritance: System.ComponentModel.Component, ISupportLifecycle, ISupportInitialize, IProvideStatus, IPersistSettings
Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Property Type Description
BeginInit void
ClientSocket_ConnectionAttempt void
ClientSocket_ConnectionEstablished void
ClientSocket_ConnectionTerminated void
ClientSocket_ReceiveDataComplete void
DataInitClient_ReceiveDataComplete void
EndInit void
PacketParser_DataParsed void
ServerSocket_ReceiveClientDataComplete void
ServerSocket_ServerStarted void
ServerSocket_ServerStopped void

Public Methods

Method Description
@Stop ( ) : void

Stops the DataListener.

DataListener ( ) : System

Initializes a new instance of the DataListener class.

DataListener ( IContainer container ) : System

Initializes a new instance of the DataListener class.

Equals ( object obj ) : bool

Determines whether the current DataListener object is equal to obj.

FindData ( int historianID ) : IDataPoint

Gets the current data for the specified historianID.

GetHashCode ( ) : int

Returns the hash code for the current DataListener object.

Initialize ( ) : void

Initializes the DataListener.

Initialize() is to be called by user-code directly only if the DataListener is not consumed through the designer surface of the IDE.

LoadSettings ( ) : void

Loads saved settings for the DataListener from the config file if the PersistSettings property is set to true.

SaveSettings ( ) : void

Saves settings for the DataListener to the config file if the PersistSettings property is set to true.

Start ( ) : void

Starts the DataListener synchronously.

StartAsync ( ) : void

Starts the DataListener asynchronously.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the DataListener and optionally releases the managed resources.

OnDataChanged ( ) : void

Raises the DataChanged event.

OnDataExtracted ( IList data ) : void

Raises the DataExtracted event.

OnDataInitComplete ( ) : void

Raises the DataInitComplete event.

OnDataInitFailure ( ) : void

Raises the DataInitFailure event.

OnDataInitPartial ( ) : void

Raises the DataInitPartial event.

OnDataInitStart ( ) : void

Raises the DataInitStart event.

OnListenerStarted ( ) : void

Raises the ListenerStarted event.

OnListenerStarting ( ) : void

Raises the ListenerStarting event.

OnListenerStopped ( ) : void

Raises the ListenerStopped event.

OnListenerStopping ( ) : void

Raises the ListenerStopping event.

OnSocketConnected ( ) : void

Raises the SocketConnected event.

OnSocketConnecting ( ) : void

Raises the SocketConnecting event.

OnSocketDisconnected ( ) : void

Raises the SocketDisconnected event.

Private Methods

Method Description
BeginInit ( ) : void
ClientSocket_ConnectionAttempt ( object sender, EventArgs e ) : void
ClientSocket_ConnectionEstablished ( object sender, EventArgs e ) : void
ClientSocket_ConnectionTerminated ( object sender, EventArgs e ) : void
ClientSocket_ReceiveDataComplete ( object sender, int>.EventArgs e ) : void
DataInitClient_ReceiveDataComplete ( object sender, int>.EventArgs e ) : void
EndInit ( ) : void
PacketParser_DataParsed ( object sender, EventArgs e ) : void
ServerSocket_ReceiveClientDataComplete ( object sender, EventArgs e ) : void
ServerSocket_ServerStarted ( object sender, EventArgs e ) : void
ServerSocket_ServerStopped ( object sender, EventArgs e ) : void

Method Details

@Stop() public method

Stops the DataListener.
public @Stop ( ) : void
return void

DataListener() public method

Initializes a new instance of the DataListener class.
public DataListener ( ) : System
return System

DataListener() public method

Initializes a new instance of the DataListener class.
public DataListener ( IContainer container ) : System
container IContainer object that contains the .
return System

Dispose() protected method

Releases the unmanaged resources used by the DataListener 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.
return void

Equals() public method

Determines whether the current DataListener object is equal to obj.
public Equals ( object obj ) : bool
obj object Object against which the current object is to be compared for equality.
return bool

FindData() public method

Gets the current data for the specified historianID.
public FindData ( int historianID ) : IDataPoint
historianID int Historian identifier whose current data is to be retrieved.
return IDataPoint

GetHashCode() public method

Returns the hash code for the current DataListener object.
public GetHashCode ( ) : int
return int

Initialize() public method

Initializes the DataListener.
Initialize() is to be called by user-code directly only if the DataListener is not consumed through the designer surface of the IDE.
public Initialize ( ) : void
return void

LoadSettings() public method

Loads saved settings for the DataListener from the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public LoadSettings ( ) : void
return void

OnDataChanged() protected method

Raises the DataChanged event.
protected OnDataChanged ( ) : void
return void

OnDataExtracted() protected method

Raises the DataExtracted event.
protected OnDataExtracted ( IList data ) : void
data IList Extracted time-series data to send to event.
return void

OnDataInitComplete() protected method

Raises the DataInitComplete event.
protected OnDataInitComplete ( ) : void
return void

OnDataInitFailure() protected method

Raises the DataInitFailure event.
protected OnDataInitFailure ( ) : void
return void

OnDataInitPartial() protected method

Raises the DataInitPartial event.
protected OnDataInitPartial ( ) : void
return void

OnDataInitStart() protected method

Raises the DataInitStart event.
protected OnDataInitStart ( ) : void
return void

OnListenerStarted() protected method

Raises the ListenerStarted event.
protected OnListenerStarted ( ) : void
return void

OnListenerStarting() protected method

Raises the ListenerStarting event.
protected OnListenerStarting ( ) : void
return void

OnListenerStopped() protected method

Raises the ListenerStopped event.
protected OnListenerStopped ( ) : void
return void

OnListenerStopping() protected method

Raises the ListenerStopping event.
protected OnListenerStopping ( ) : void
return void

OnSocketConnected() protected method

Raises the SocketConnected event.
protected OnSocketConnected ( ) : void
return void

OnSocketConnecting() protected method

Raises the SocketConnecting event.
protected OnSocketConnecting ( ) : void
return void

OnSocketDisconnected() protected method

Raises the SocketDisconnected event.
protected OnSocketDisconnected ( ) : void
return void

SaveSettings() public method

Saves settings for the DataListener to the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public SaveSettings ( ) : void
return void

Start() public method

Starts the DataListener synchronously.
public Start ( ) : void
return void

StartAsync() public method

Starts the DataListener asynchronously.
public StartAsync ( ) : void
return void