Schedule

Namespace: FSharp.Control.Reactive

The Reactive module provides operators for working with IScheduler<_> in F#.

Functions and values

Function or value	Description
`action f sch` Signature: f:(unit -> unit) -> sch:IScheduler -> IDisposable	Schedules an function to be executed.
`actionAccOffsetRec state dueTime ff sch` Signature: state:'state -> dueTime:DateTimeOffset -> ff:('state -> ('state -> DateTimeOffset -> unit) -> unit) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules an function to be executed recursively at a specified absolute due time.
`actionAccRec state ff sch` Signature: state:'state -> ff:('state -> ('state -> unit) -> unit) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules an function to be executed recursively.
`actionAccSpanRec state dueTime ff sch` Signature: state:'state -> dueTime:TimeSpan -> ff:('state -> ('state -> TimeSpan -> unit) -> unit) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules an function to be executed recursively after a specified relative due time.
`actionLong f sch` Signature: f:(ICancelable -> unit) -> sch:ISchedulerLongRunning -> IDisposable	Schedules an function to be executed.
`actionLongState state f sch` Signature: state:'?8916 -> f:('?8916 -> ICancelable -> '?8917) -> sch:ISchedulerLongRunning -> IDisposable Type parameters: '?8916, '?8917	Schedules a long-running piece of work.
`actionOffset offset f sch` Signature: offset:DateTimeOffset -> f:(unit -> unit) -> sch:IScheduler -> IDisposable	Schedules an function to be executed at a specified absolute time.
`actionOffsetRec dueTime ff sch` Signature: dueTime:DateTimeOffset -> ff:((unit -> unit) -> unit) -> sch:IScheduler -> IDisposable	Schedules an function to be executed recursively at a specified absolute due time.
`actionRec ff sch` Signature: ff:((unit -> unit) -> unit) -> sch:IScheduler -> IDisposable	Schedules an function to be executed recursively.
`actionSpanRec time ff sch` Signature: time:TimeSpan -> ff:(TimeSpan -> (TimeSpan -> unit) -> unit) -> sch:IScheduler -> IDisposable	Schedules an function to be executed recursively.
`asAsync(cta)` Signature: cta:SchedulerOperation -> Async<unit>
`asTask ct async` Signature: ct:CancellationToken -> async:Async<'T> -> Task<'T> Type parameters: 'T
`async f sch` Signature: f:(IScheduler -> CancellationToken -> Async<'?8952>) -> sch:IScheduler -> IDisposable Type parameters: '?8952	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccOffsetResult state dueTime f sch` Signature: state:'state -> dueTime:DateTimeOffset -> f:(IScheduler -> 'state -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccOffsetUnit state dueTime f sch` Signature: state:'state -> dueTime:DateTimeOffset -> f:(IScheduler -> 'state -> CancellationToken -> Async<'?8972>) -> sch:IScheduler -> IDisposable Type parameters: 'state, '?8972	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccResult state f sch` Signature: state:'state -> f:(IScheduler -> 'state -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccSpanResult state dueTime f sch` Signature: state:'state -> dueTime:TimeSpan -> f:(IScheduler -> 'state -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable Type parameters: 'state	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccSpanUnit state dueTime f sch` Signature: state:'state -> dueTime:TimeSpan -> f:(IScheduler -> 'state -> CancellationToken -> Async<'?8967>) -> sch:IScheduler -> IDisposable Type parameters: 'state, '?8967	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncAccUnit state f sch` Signature: state:'state -> f:(IScheduler -> 'state -> CancellationToken -> Async<'?8956>) -> sch:IScheduler -> IDisposable Type parameters: 'state, '?8956	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncOffsetResult dueTime f sch` Signature: dueTime:DateTimeOffset -> f:(IScheduler -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncOffsetUnit dueTime f sch` Signature: dueTime:DateTimeOffset -> f:(IScheduler -> CancellationToken -> Async<'?8963>) -> sch:IScheduler -> IDisposable Type parameters: '?8963	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncResult f sch` Signature: f:(IScheduler -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncSpanResult dueTime f sch` Signature: dueTime:TimeSpan -> f:(IScheduler -> CancellationToken -> Async<IDisposable>) -> sch:IScheduler -> IDisposable	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`asyncSpanUnit dueTime f sch` Signature: dueTime:TimeSpan -> f:(IScheduler -> CancellationToken -> Async<'?8960>) -> sch:IScheduler -> IDisposable Type parameters: '?8960	Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style.
`catch f sch` Signature: f:('?8941 -> bool) -> sch:IScheduler -> IScheduler Type parameters: '?8941	Returns a scheduler that wraps the original scheduler, adding exception handling for scheduled actions.
`disableOptimizations(arg00)` Signature: arg00:IScheduler -> IScheduler	Returns a scheduler that represents the original scheduler, without any of its interface-based optimizations (e.g. long running scheduling).
`disableOptimizationsTypes(...)` Signature: optimizationInterfaces:Type list -> sch:IScheduler -> IScheduler	Returns a scheduler that represents the original scheduler, without any of its interface-based optimizations (e.g. long running scheduling).
`func state f sch` Signature: state:'?8919 -> f:(IScheduler -> '?8919 -> IDisposable) -> sch:IScheduler -> IDisposable Type parameters: '?8919	Schedules a function to be executed.
`funcOffset state dueTime f sch` Signature: state:'?8923 -> dueTime:DateTimeOffset -> f:(IScheduler -> '?8923 -> IDisposable) -> sch:IScheduler -> IDisposable Type parameters: '?8923	Schedules a function to be executed at dueTime.
`funcSpan state dueTime f sch` Signature: state:'?8921 -> dueTime:TimeSpan -> f:(IScheduler -> '?8921 -> IDisposable) -> sch:IScheduler -> IDisposable Type parameters: '?8921	Schedules a function to be executed after dueTime.
`multiple fs sch` Signature: fs:(IScheduler -> IDisposable) list -> sch:IScheduler -> IDisposable	Schedule multiple 'schedule' operations together
`periodicAcc state period f sch` Signature: state:'?8934 -> period:TimeSpan -> f:('?8934 -> '?8934) -> sch:IScheduler -> IDisposable Type parameters: '?8934	Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. Otherwise, the periodic task will be emulated using recursive scheduling.
`periodicAccAction state period f sch` Signature: state:'?8936 -> period:TimeSpan -> f:('?8936 -> unit) -> sch:IScheduler -> IDisposable Type parameters: '?8936	Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. Otherwise, the periodic task will be emulated using recursive scheduling.
`periodicAction period f sch` Signature: period:TimeSpan -> f:(unit -> unit) -> sch:IScheduler -> IDisposable	Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. Otherwise, the periodic task will be emulated using recursive scheduling.
`sleep dueTime sch` Signature: dueTime:TimeSpan -> sch:IScheduler -> Async<unit>	Suspends execution of the current work item on the scheduler for the specified duration. The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified duration.
`sleepCancel dueTime ct sch` Signature: dueTime:TimeSpan -> ct:CancellationToken -> sch:IScheduler -> Async<unit>	Suspends execution of the current work item on the scheduler for the specified duration. The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified duration.
`sleepOffset dueTime sch` Signature: dueTime:DateTimeOffset -> sch:IScheduler -> Async<unit>	Suspends execution of the current work item on the scheduler for the specified duration. The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified due time.
`sleepOffsetCancel dueTime ct sch` Signature: dueTime:DateTimeOffset -> ct:CancellationToken -> sch:IScheduler -> Async<unit>	Suspends execution of the current work item on the scheduler for the specified duration. The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified due time.
`yield_(x)` Signature: x:IScheduler -> Async<unit>	Yields execution of the current work item on the scheduler to another work item on the scheduler. The caller should await the result of calling 'yield' to schedule the remainder of the current work item (known as the continuation).
`yieldCancel ct sch` Signature: ct:CancellationToken -> sch:IScheduler -> Async<unit>	Yields execution of the current work item on the scheduler to another work item on the scheduler. The caller should await the result of calling 'yield' to schedule the remainder of the current work item (known as the continuation).