WasmScheduler.SchedulePeriodic(TState, TimeSpan, Func) method¶
Defined in
Type: WasmScheduler
Namespace: ReactiveUI.Primitives.Reactive.Concurrency
Assembly: ReactiveUI.Primitives.Reactive.dll
Applies to
net10.0, net10.0-android36.0, net10.0-ios26.0, net10.0-macos26.0, net10.0-tvos26.0, net10.0-maccatalyst26.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-desktop1.0, net9.0-browserwasm1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net481, net471, net462
public IDisposable SchedulePeriodic<TState>(TState state, TimeSpan period, Func<TState, TState> action)
Summary:
Schedules a periodic action. Periods below one millisecond (including zero) are clamped to one millisecond:
a tight sequential loop would starve a single-threaded event loop, and browsers clamp nested
setTimeout anyway.
Type parameters
| Name | Description |
|---|---|
TState | The type of the state passed to the action. |
Parameters
| Name | Type | Description |
|---|---|---|
state | TState | Initial state passed to the action upon the first iteration. |
period | TimeSpan | Period for running the work periodically. |
action | Func | Action to be executed, potentially updating the state. |
Returns: IDisposable -- The disposable used to cancel the scheduled recurring action.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | action is null. |
| System.ArgumentOutOfRangeException | period is negative. |