OpenTAP 9.24
API Reference
Public Member Functions | Protected Member Functions | List of all members
OpenTap.Diagnostic.LogFile Class Reference

A simple log listener that writes events to a binary file. More...

Inheritance diagram for OpenTap.Diagnostic.LogFile:
OpenTap.Diagnostic.ILogListener

Public Member Functions

 LogFile (Stream st)
 Initializes a new instance of the LogFile class. Logs events to a given stream. More...
 
void EventsLogged (IEnumerable< Event > logEvents)
 Implements the ILogListener method. More...
 
void Close ()
 This method must be called to close the stream.
 
void Flush ()
 Flush the current stream.
 
void Dispose ()
 Dispose method since BufferedStream implements IDisposable.
 

Protected Member Functions

virtual void Dispose (bool cleanupScope)
 Dispose method since BufferedStream implements IDisposable. More...
 

Detailed Description

A simple log listener that writes events to a binary file.

Constructor & Destructor Documentation

◆ LogFile()

OpenTap.Diagnostic.LogFile.LogFile ( Stream  st)
inline

Initializes a new instance of the LogFile class. Logs events to a given stream.

Parameters
stThe stream to use.

Member Function Documentation

◆ Dispose()

virtual void OpenTap.Diagnostic.LogFile.Dispose ( bool  cleanupScope)
inlineprotectedvirtual

Dispose method since BufferedStream implements IDisposable.

Parameters
cleanupScopeIf false, cleanup native resources, if true, clean up native and managed.

◆ EventsLogged()

void OpenTap.Diagnostic.LogFile.EventsLogged ( IEnumerable< Event logEvents)
inline

Implements the ILogListener method.

Parameters
logEventsEvents array.

Implements OpenTap.Diagnostic.ILogListener.

OpenTAP 9.24 API built Mon May 6 2024 11:38:44