OpenTAP 9.34
API Reference
OpenTap.Diagnostic.BinaryLog Class Reference

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

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

Public Member Functions

 BinaryLog (Stream st)
 Initializes a new instance of the BinaryLog class. Logs events to a given stream.
 
void Close ()
 Method that must be called to properly close the stream.

 
void Flush ()
 Flushes the messages from the listener.

 
void EventsLogged (IEnumerable< Event > logEvents)
 Logs the events.

 
void Dispose ()
 Resets and releases resources for this unmanaged class.
 
- Public Member Functions inherited from OpenTap.Diagnostic.ILogListener

Protected Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ BinaryLog()

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

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

Parameters
stThe stream to use.

Member Function Documentation

◆ Dispose()

virtual void OpenTap.Diagnostic.BinaryLog.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.BinaryLog.EventsLogged ( IEnumerable< Event > logEvents)
inline

Logs the events.

Parameters
logEventsList of events to log.

Implements OpenTap.Diagnostic.ILogListener.

OpenTAP 9.34 API built Wed Jul 1 2026 09:21:15