ATAS.Indicators.Heatmap.IHeatmapIndicatorRuntime Interface Reference

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 IHeatmapIndicator.OnStateResetNotificationAsync calls. More...

Public Member Functions
ValueTask	RequestReWarmAsync (string reason, CancellationToken cancellationToken)
	Ask the platform to re-issue IHeatmapWarmupIndicator.WarmUpAsync 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	RequestStateResetAsync (string reason, CancellationToken cancellationToken)
	Ask the platform to perform a full state reset. The platform clears every series in the indicator's IHeatmapIndicator.State (front and back), then calls IHeatmapIndicator.OnStateResetNotificationAsync, 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).

Detailed Description

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 IHeatmapIndicator.OnStateResetNotificationAsync calls.

Member Function Documentation

RequestReWarmAsync()

ValueTask ATAS.Indicators.Heatmap.IHeatmapIndicatorRuntime.RequestReWarmAsync	(	string	reason,
		CancellationToken	cancellationToken
	)

Ask the platform to re-issue IHeatmapWarmupIndicator.WarmUpAsync 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).

Parameters

reason

Free-form diagnostic string describing why the indicator wants to re-warm. Surfaced in logs when the warm-up host has nothing to produce.

RequestStateResetAsync()

ValueTask ATAS.Indicators.Heatmap.IHeatmapIndicatorRuntime.RequestStateResetAsync	(	string	reason,
		CancellationToken	cancellationToken
	)

Ask the platform to perform a full state reset. The platform clears every series in the indicator's IHeatmapIndicator.State (front and back), then calls IHeatmapIndicator.OnStateResetNotificationAsync, 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).

---

The documentation for this interface was generated from the following file:

• IHeatmapIndicator.cs