C# Class GSF.Snap.Services.Writer.RolloverLogFile

Logs the rollover process so that it can be properly finished in the event of a power outage or process crash
Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Properties

Property Type Description
DestinationFile System.Guid
FileName string
IsValid bool
SourceFiles List

Public Methods

Method Description
Delete ( ) : void

Deletes the file associated with this ArchiveLog
Recover ( ArchiveList list ) : void

Recovers this rollover during an application crash.
RolloverLogFile ( string fileName ) : GSF.Diagnostics

Resumes a rollover log
RolloverLogFile ( string fileName, List sourceFiles, System.Guid destinationFile ) : GSF.Diagnostics

Creates a new rollover log

Private Methods

Method Description
RolloverLogFile ( ) : GSF.Diagnostics

Method Details

Delete() public method

Deletes the file associated with this ArchiveLog
public Delete ( ) : void
return void

Recover() public method

Recovers this rollover during an application crash.
public Recover ( ArchiveList list ) : void
list ArchiveList
return void

RolloverLogFile() public method

Resumes a rollover log
public RolloverLogFile ( string fileName ) : GSF.Diagnostics
fileName string the name of the log file to load.
return GSF.Diagnostics

RolloverLogFile() public method

Creates a new rollover log
public RolloverLogFile ( string fileName, List sourceFiles, System.Guid destinationFile ) : GSF.Diagnostics
fileName string the name of the file to save
sourceFiles List the source files in the rollover process
destinationFile System.Guid the destination file in the rollover process.
return GSF.Diagnostics

Property Details

DestinationFile public property

Gets the destination file
public Guid,System DestinationFile
return System.Guid

FileName public property

Gets the filename of this log file. String.Empty if not currently associated with a file.
public string FileName
return string

IsValid public property

Gets if the file is valid and not corrupt.
public bool IsValid
return bool

SourceFiles public property

Gets all of the source files.
public List SourceFiles
return List