Table of Contents

Interface IHeatmapIndicatorWarmupHost

Namespace
OFT.Rendering.Heatmap
Assembly
OFT.Rendering.dll

Contract supplied by the heatmap host (typically the heatmap view-model) that lets the controller pull a fresh warm-up bundle whenever it needs one. The controller never invents a HeatmapIndicatorWarmupRequest or an IHeatmapIndicatorDataSources on its own — it cannot, since it does not know the active instrument, the heatmap data range, or the cache locations.

Added in ATAS 8.0.15.

public interface IHeatmapIndicatorWarmupHost
Extension Methods

Methods

PrepareWarmupAsync(CancellationToken)

Build a fresh warm-up bundle (request + data sources) for the current host state. Returns null when there is nothing to warm up (no active instrument, no resolvable time range, etc.); the controller treats null as a no-op for that warm-up attempt and leaves any previous successful state in place.

Called by the controller on HeatmapIndicatorsController.WarmUpAllAsync, HeatmapIndicatorsController.WarmUpInstanceAsync, and IHeatmapIndicatorRuntime.RequestReWarmAsync.

The returned bundle's IHeatmapIndicatorDataSources must remain usable for the duration of the warm-up call; the controller does not cache it across calls.

Concurrency: implementations must be safe to call concurrently. Bulk warm-up (WarmUpAllAsync) is coalesced inside the controller, but per-instance re-warm (RequestReWarmAsync) is per-runner and runs in parallel with the bulk path. The host therefore must not assume that PrepareWarmupAsync calls are serialised. 

ValueTask<HeatmapIndicatorWarmupBundle?> PrepareWarmupAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<HeatmapIndicatorWarmupBundle>