DefaultScheduler.SchedulePeriodic(TState, TimeSpan, Func) method¶
Defined in
Type: DefaultScheduler
Namespace: System.Reactive.Concurrency
Assembly: System.Reactive.dll
Applies to
netstandard2.0
public IDisposable SchedulePeriodic<TState>(TState state, TimeSpan period, Func<TState, TState> action)
Summary: Schedules a periodic piece of work, using a System.Threading.Timer object.
Type parameters
| Name | Description |
|---|---|
TState | The type of the state passed to the scheduled 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 object used to cancel the scheduled recurring action (best effort).
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | period is less than Zero. |
| System.ArgumentNullException | action is null. |