C# Class GSF.IO.RunTimeLog

Represents a persisted run-time log that tracks last start, stop and running times.

Inheritance: ISupportLifecycle, IProvideStatus

Mostra file Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Property	Type	Description
m_flushTimer_Elapsed	void

Public Methods

Method	Description
Dispose ( ) : void	Releases all the resources used by the RunTimeLog object.
Initialize ( ) : void	Initialize the run-time log. Initialization performs initial run-time log read, establishes new start time and enables automatic write log timer. Last logged stop time will be validated against last logged running time. If the last logged running time is later than the last logged stop time, the stop time will be set to the running time with the assumption that the log file was not properly shut down (e.g., due to abnormal host termination). It is important to separate initialization from construction such that consumer can attach to events before class is initialized in case initialization causes events to be raised.
RunTimeLog ( ) : System	Creates a new run-time log.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the RunTimeLog object and optionally releases the managed resources.
OnProcessException ( Exception ex ) : void	Raises ProcessException event.
ReadLog ( ) : void	Reads the run-time log.
WriteLog ( ) : void	Writes the run-time log - times are in a human readable format.

Private Methods

Method	Description
m_flushTimer_Elapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void

Method Details

Dispose() public method

Releases all the resources used by the RunTimeLog object.

public Dispose ( ) : void
return	void

Dispose() protected method

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

Initialize() public method

Initialize the run-time log.

Initialization performs initial run-time log read, establishes new start time and enables automatic write log timer.

Last logged stop time will be validated against last logged running time. If the last logged running time is later than the last logged stop time, the stop time will be set to the running time with the assumption that the log file was not properly shut down (e.g., due to abnormal host termination).

It is important to separate initialization from construction such that consumer can attach to events before class is initialized in case initialization causes events to be raised.

public Initialize ( ) : void
return	void

OnProcessException() protected method

Raises ProcessException event.

protected OnProcessException ( Exception ex ) : void
ex	System.Exception	Processing .
return	void

ReadLog() protected method

Reads the run-time log.

protected ReadLog ( ) : void
return	void

RunTimeLog() public method

Creates a new run-time log.

public RunTimeLog ( ) : System
return	System

WriteLog() protected method

Writes the run-time log - times are in a human readable format.

protected WriteLog ( ) : void
return	void