HistoricalScheduler Class

  • Article

Provides a virtual time scheduler that uses DateTimeOffset for absolute time and TimeSpan for relative time.

Inheritance Hierarchy

System.Object
  System.Reactive.Concurrency.VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>
    System.Reactive.Concurrency.HistoricalSchedulerBase
      System.Reactive.Concurrency.HistoricalScheduler

Namespace:  System.Reactive.Concurrency
Assembly:  System.Reactive (in System.Reactive.dll)

Syntax

'Declaration
Public Class HistoricalScheduler _
    Inherits HistoricalSchedulerBase

'Usage
Dim instance As HistoricalScheduler

public class HistoricalScheduler : HistoricalSchedulerBase

public ref class HistoricalScheduler : public HistoricalSchedulerBase

type HistoricalScheduler =  
    class
        inherit HistoricalSchedulerBase
    end

public class HistoricalScheduler extends HistoricalSchedulerBase

The HistoricalScheduler type exposes the following members.

Constructors

  Name Description
Public method HistoricalScheduler Initializes a new instance of the HistoricalScheduler class.

Top

Properties

  Name Description
Public property Clock Gets the scheduler's absolute time clock value. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Protected property Comparer Gets the comparer used to compare absolute time values. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public property IsEnabled Gets whether the scheduler is enabled to run work. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public property Now Gets the scheduler's notion of current time. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)

Top

Methods

  Name Description
Protected method Add Adds a relative time to an absolute time value. (Inherited from HistoricalSchedulerBase.)
Public method AdvanceBy Advances the scheduler's clock by the specified relative time, running all work scheduled for that timespan. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method AdvanceTo Advances the scheduler's clock to the specified time, running all work till that point. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetNext Gets the next scheduled item to be executed. (Overrides VirtualTimeSchedulerBase<TAbsolute, TRelative>.GetNext().)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Schedule<TState>(TState, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method Schedule<TState>(TState, DateTimeOffset, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed at dueTime. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method Schedule<TState>(TState, TimeSpan, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed after dueTime. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method ScheduleAbsolute<TState>(TState, DateTimeOffset, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed at dueTime. (Overrides VirtualTimeSchedulerBase<TAbsolute, TRelative>.ScheduleAbsolute<TState>(TState, TAbsolute, Func<IScheduler, TState, IDisposable>).)
Public method ScheduleAbsolute<TState>(TState, TAbsolute, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed at dueTime. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method ScheduleRelative<TState> Schedules an action to be executed at dueTime. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method Start Starts the virtual time scheduler. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Public method Stop Stops the virtual time scheduler. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Protected method ToDateTimeOffset Converts the absolute time value to a DateTimeOffset value. (Inherited from HistoricalSchedulerBase.)
Protected method ToRelative Converts the TimeSpan value to a relative time value. (Inherited from HistoricalSchedulerBase.)
Public method ToString (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Reactive.Concurrency Namespace