OpenTAP 9.24
API Reference
Public Member Functions | Events | List of all members
OpenTap.EventTraceListener Class Reference

A class that listens to trace messages and raises an event when a message occurs. More...

Inheritance diagram for OpenTap.EventTraceListener:
OpenTap.TraceListener OpenTap.Diagnostic.ILogListener

Public Member Functions

delegate void LogMessageDelegate (IEnumerable< Event > Events)
 Delegate for the log messages. More...
 
override void TraceEvents (IEnumerable< Event > events)
 Invokes the MessageLogged event with the new events. More...
 
override void TraceEvent (string source, LogEventType eventType, int id, string text)
 Invokes the MessageLogged event with the new event from the legacy TraceEvent system. More...
 
 EventTraceListener ()
 Constructor of the EventTraceListener.
 
- Public Member Functions inherited from OpenTap.TraceListener
virtual void TraceEvent (string source, LogEventType eventType, int id, string format, params object[] args)
 Empty TraceEvent method.
 
virtual void Write (string str)
 Virtual method to match System.Diagnostics.TraceListener. Might be removed.
 
virtual void WriteLine (string str)
 Virtual method to match System.Diagnostics.TraceListener. Might be removed.
 
virtual void Flush ()
 Waits until all sent log messages have been processed by this and all other TraceListeners.
 

Events

LogMessageDelegate MessageLogged
 Event for when messages are logged.
 

Detailed Description

A class that listens to trace messages and raises an event when a message occurs.

Member Function Documentation

◆ LogMessageDelegate()

delegate void OpenTap.EventTraceListener.LogMessageDelegate ( IEnumerable< Event Events)

Delegate for the log messages.

Parameters
Events

◆ TraceEvent()

override void OpenTap.EventTraceListener.TraceEvent ( string  source,
LogEventType  eventType,
int  id,
string  text 
)
inlinevirtual

Invokes the MessageLogged event with the new event from the legacy TraceEvent system.

Parameters
source
eventType
id
text

Reimplemented from OpenTap.TraceListener.

◆ TraceEvents()

override void OpenTap.EventTraceListener.TraceEvents ( IEnumerable< Event events)
inlinevirtual

Invokes the MessageLogged event with the new events.

Parameters
events

Reimplemented from OpenTap.TraceListener.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:41