ListenerSpan¶

Namespace: SideXP.Broadcaster

public sealed class ListenerSpan

The monitor's record of one callback invoked by a DispatchSpan: who owned it, what role it played, when it ran, and how it finished. "Listener" is the generic word for any invoked callback (a signal listener, a cue performer, or a handler).

Remarks

The same instance is handed to ListenerBegan and later ListenerEnded. A durative cue performer stays open until its work finishes, so its sub-span can end well after the dispatch's synchronous start. Only produced in the editor and development builds; release builds never produce one.

Properties¶

Span¶

public DispatchSpan Span

The dispatch this callback was invoked by.

Owner¶

public object Owner

The owner that registered the callback.

Role¶

public RegistrationRole Role

What the callback was (listener, performer, or handler).

BeginFrame¶

public int BeginFrame

The frame the callback started on.

BeginTime¶

public double BeginTime

The realtime (seconds since startup) the callback started at.

EndFrame¶

public int EndFrame

The frame the callback finished on. Meaningful once IsComplete is true.

EndTime¶

public double EndTime

The realtime (seconds since startup) the callback finished at. Meaningful once IsComplete is true.

Outcome¶

public DispatchOutcome Outcome

How the callback finished. Meaningful once IsComplete is true.

Exception¶

public Exception Exception

The exception the callback threw, when Outcome is Faulted; otherwise null.

IsComplete¶

public bool IsComplete

Whether the callback has finished (its end fields and Outcome are set).