Skip to content
ConsoleMonster

API Reference

Interface

ILiveTarget

Edit on GitHub
Namespace ConsoleMonster.Live
Assembly ConsoleMonster
Source ILiveTarget.cs:7
Modifiers abstract

A widget that accepts live updates. ILiveTarget.Apply and ILiveTarget.Describe are only ever called on the session's render thread (or on the definition thread when no session is attached), so implementations keep plain, unsynchronised state.

Usage

Explore 3 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.

Accepted by parameters 3

Methods

public abstract Void Apply(LiveEvent liveEvent) #
Returns: Void

Applies an event to the widget's state.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent requiredposition: 0
The event.
public abstract String? Describe(LiveEvent liveEvent) #
Returns: String?

Returns a line describing the event for line-based outputs (Stream/Plain), or null when the event is not worth a line (for example a single counter increment). Called after ILiveTarget.Apply.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent requiredposition: 0
The event that was applied.

Returns

A plain line or null.

Properties

public abstract String Name { get; } #

The unique name events are addressed to.