OpenTAP 9.27
API Reference
Public Member Functions | Properties | List of all members
OpenTap.Diagnostic.ILogContext2 Interface Reference

Extended ILogContext interface. More...

Inheritance diagram for OpenTap.Diagnostic.ILogContext2:
OpenTap.Diagnostic.ILogContext

Public Member Functions

void AddEvent (Event @event)
 Registers a new event More...
 
- Public Member Functions inherited from OpenTap.Diagnostic.ILogContext
ILog CreateLog (string Source)
 Creates a log source with a given source identifier. More...
 
void RemoveLog (ILog LogSource)
 Removes a log source from the context. More...
 
void AttachListener (ILogListener Listener)
 Attaches a log listener.
 
void DetachListener (ILogListener Listener)
 Detaches a log listener. Automatically flushes the context.
 
bool Flush (int TimeoutMS=0)
 Flush all events received at the time instant this method is called, but only waits a number of milliseconds. More...
 
bool Flush (TimeSpan Timeout)
 Flush all events received at the time instant this method is called, but only waits a given duration. More...
 

Properties

bool HasListeners [get]
 gets if the context has any listeners.
 
- Properties inherited from OpenTap.Diagnostic.ILogContext
ILogTimestampProvider Timestamper [getset]
 Timestamp method to use for all subsequent logged events.
 
bool Async [getset]
 When true, sets the log context to an asynchronous mode (avoiding the potential synchronous mode problem of log sources returning from ILog.LogEvent(int, string) calls before the events have been processed). When false, log sources always wait until all log listeners have processed the events.

 
int MessageBufferSize [getset]
 Maximum number of outstanding events. Only relevant for Async mode.

 

Detailed Description

Extended ILogContext interface.

Member Function Documentation

◆ AddEvent()

void OpenTap.Diagnostic.ILogContext2.AddEvent ( Event event)

Registers a new event

Parameters
event

OpenTAP 9.27 API built Wed Nov 27 2024 13:14:46