Skip to content
ConsoleMonster

API Reference

Class

LiveSessionCounters

Namespace ConsoleMonster.Live
Assembly ConsoleMonster
Modifiers sealed

A point-in-time snapshot of a live session's counters and errors (LiveSession.GetCounters).

Inheritance

  • Object
  • LiveSessionCounters

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public LiveSessionCounters(Int64 eventsPosted, Int64 eventsApplied, Int64 eventsDropped, Int64 applyErrors, Int64 renderErrors, Int64 framesRendered, Int64 resizes, IReadOnlyDictionary<String, Int64> unknownTargets, Exception? lastError, Exception? failure) #

Creates a snapshot.

Parameters

eventsPosted System.Int64 requiredposition: 0
Events accepted.
eventsApplied System.Int64 requiredposition: 1
Events applied.
eventsDropped System.Int64 requiredposition: 2
Events ignored (unknown target, or posted after admission closed).
applyErrors System.Int64 requiredposition: 3
Target Apply calls that threw.
renderErrors System.Int64 requiredposition: 4
Frames replaced by the one-line error note.
framesRendered System.Int64 requiredposition: 5
Frames rendered.
resizes System.Int64 requiredposition: 6
Size changes redrawn.
unknownTargets System.Collections.Generic.IReadOnlyDictionary<System.String, System.Int64> requiredposition: 7
Target names that received events but do not exist, with event counts.
lastError System.Exception? requiredposition: 8
The most recent error, or null.
failure System.Exception? requiredposition: 9
The error that ended the session early, or null.

Properties

public Int64 EventsPosted { get; } #

Events accepted before shutdown closed admission.

public Int64 EventsApplied { get; } #

Events applied successfully.

public Int64 EventsDropped { get; } #

Events ignored: sent to an unknown target, or posted after admission closed.

public Int64 ApplyErrors { get; } #

Target Apply calls that threw.

public Int64 RenderErrors { get; } #

Frames where the layout threw and a one-line note was shown instead.

public Int64 FramesRendered { get; } #

Frames rendered, including the final frame.

public Int64 Resizes { get; } #

Size changes the session redrew for.

public IReadOnlyDictionary<String, Int64> UnknownTargets { get; } #

Target names that received events but are not registered (typos such as lanez), with event counts.

public Int64 UnknownTargetEvents { get; } #

Events sent to unknown targets.

public Exception? LastError { get; } #

The most recent target, rendering, recording or cleanup error, or null.

public Exception? Failure { get; } #

The error that ended the session early, or null.

public Boolean HasProblems { get; } #

Whether anything went wrong: failed updates, failed frames, unknown targets or an early end.