Repository navigation
Running IntervalAction cannot change its interval; README "Dynamic Interval Adjustment" example does not compile #80
Description
Activity
Triage
- Category: Improvement. The documentation is wrong now (the README example doesn't compile, and the API table lists members that don't exist). Supporting a live interval change would be a feature request.
- Priority: Medium. Anyone following the documented example gets a build failure, and there's no API that gives the documented behaviour.
- Area / suggested owner: The
IntervalActioncore API and README. - Duplicates / related: Related to An IntervalAction that is dropped without Stop() runs forever: it is never collected and has no Dispose, though README lists one #71 (Dispose) and The README's
Action = async () => …becomes async void: executions overlap, FromLastCompletion measures from the first await, and a throw crashes the process #59 / PR Add AsyncAction so async work is awaited, not run as async void [minor] #78 (async actions), but not covered by either. Open PRs Cancel the polling delay on Stop and restart, so Restart() returns promptly [patch] #77 and Add AsyncAction so async work is awaited, not run as async void [minor] #78 don't touch interval changes. Cancel the polling delay on Stop and restart, so Restart() returns promptly [patch] #77's Restart rework is the natural place to put aRestart(IntervalActionOptions)overload once it merges. - In progress: No open PR covers this.
- Next step: Fix the README straight away: remove or rewrite the "Dynamic Interval Adjustment" example and drop the
IsRunning/Optionsrows. Then decide whether to addChangeInterval(TimeSpan)orRestart(options), with a test showing the new interval takes effect from the next tick.
Generated by Claude Code
What's wrong
The README's "Dynamic Interval Adjustment" example (README.md ~L124-140) builds an
IntervalActionOptions, starts the action, and then assigns:IntervalActionOptions.ActionIntervalis{ get; init; }(IntervalAction/IntervalActionOptions.cs:35), so this is compile error CS8852. Even if it compiled, it would have no effect:IntervalAction.Startcopies the options into the instance's private init-onlyActionInterval(IntervalAction/IntervalAction.cs:61,:147), andRestart()/RestartAsync()never re-read the options.The README API table also lists
IsRunningandOptionsproperties (README.md ~L154-155) that do not exist onIntervalAction.Why it matters
A user who follows the documented example to speed up or slow down a running action gets a build failure, and there's no public API to achieve the documented behaviour. The only route is
Stop()followed by a freshStart(...), which loses the last-run timestamp and any pending exception state.Suggested fix / acceptance criteria
Either:
Restart(IntervalActionOptions)/ChangeInterval(TimeSpan), or a thread-safe settable interval), with a test showing the new interval takes effect from the next tick; and update the README example to use it; orIsRunning/Optionsrows from the README.Related but distinct: #71 (Dispose), #59 / PR #78 (async actions).