Interface IHeatmapIndicatorRuntime
- Namespace
- ATAS.Indicators.Heatmap
- Assembly
- ATAS.Indicators.dll
Runtime handle the platform passes to indicators at warm-up / reset time. Lets the indicator drive its own re-warm or full state reset from any of its async methods. The handle is rebound on every reset, so indicators MUST NOT retain a runtime reference across OnStateResetNotificationAsync(IHeatmapIndicatorContext, IHeatmapIndicatorRuntime, CancellationToken) calls.
Added in ATAS 8.0.15.
public interface IHeatmapIndicatorRuntime
- Extension Methods
Methods
RaiseAlertAsync(HeatmapIndicatorAlert, CancellationToken)
Raise a user-facing alert (alerts window entry + sound/notification per the user's alert settings) on behalf of this indicator instance. The host decides how to route it — the heatmap forwards to the platform alert provider with the panel's identity attached. The default implementation ignores the alert so runtime hosts that predate this capability (tests, custom harnesses) keep compiling and working.
ValueTask RaiseAlertAsync(HeatmapIndicatorAlert alert, CancellationToken cancellationToken)
Parameters
alertHeatmapIndicatorAlertcancellationTokenCancellationToken
Returns
- ValueTask
RequestReWarmAsync(string, CancellationToken)
Ask the platform to re-issue WarmUpAsync(HeatmapIndicatorWarmupRequest, IHeatmapIndicatorDataSources, CancellationToken) for this instance. The controller pulls a fresh HeatmapIndicatorWarmupBundle from the IHeatmapIndicatorWarmupHost and queues a warm-up work item on the instance's own channel (serialised against any in-flight call; observes the supervisor's per-call timeout).
ValueTask RequestReWarmAsync(string reason, CancellationToken cancellationToken)
Parameters
reasonstringFree-form diagnostic string describing why the indicator wants to re-warm. Surfaced in logs when the warm-up host has nothing to produce.
cancellationTokenCancellationTokenCancels the re-warm request.
Returns
- ValueTask
RequestStateResetAsync(string, CancellationToken)
Ask the platform to perform a full state reset. The platform clears
every series in the indicator's State
(front and back), then calls
OnStateResetNotificationAsync(IHeatmapIndicatorContext, IHeatmapIndicatorRuntime, CancellationToken), then
queues the next warm-up + tick callbacks. Use only when settings or
ingestion state changed in a way that invalidates everything;
for a background rebuild that should not blank the front, take a
lease and call Clear() + refill in the same lease (see
HeatmapIndicatorsDesign.md §5.2).
ValueTask RequestStateResetAsync(string reason, CancellationToken cancellationToken)
Parameters
reasonstringcancellationTokenCancellationToken
Returns
- ValueTask