TestScheduler Class

  • Article

Base class for testing Rx code.

Inheritance Hierarchy

System.Object
  System.Reactive.Concurrency.VirtualTimeSchedulerBase<Int64, Int64>
    System.Reactive.Concurrency.VirtualTimeScheduler<Int64, Int64>
      Microsoft.Reactive.Testing.TestScheduler

Namespace:  Microsoft.Reactive.Testing
Assembly:  Microsoft.Reactive.Testing (in Microsoft.Reactive.Testing.dll)

Syntax

'Declaration
Public Class TestScheduler _
    Inherits VirtualTimeScheduler(Of Long, Long)

'Usage
Dim instance As TestScheduler

public class TestScheduler : VirtualTimeScheduler<long, long>

public ref class TestScheduler : public VirtualTimeScheduler<long long, long long>

type TestScheduler =  
    class
        inherit VirtualTimeScheduler<int64, int64>
    end

public class TestScheduler extends VirtualTimeScheduler<long, long>

The TestScheduler type exposes the following members.

Constructors

  Name Description
Public method TestScheduler Initializes a new instance of the TestScheduler 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 virtual time to an absolute virtual time value. (Overrides VirtualTimeSchedulerBase<TAbsolute, TRelative>.Add(TAbsolute, TRelative).)
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 CreateColdObservable<T> Creates a cold observable.
Public method CreateHotObservable<T> Creates a hot observable.
Public method CreateObserver<T> Creates a testable observer.
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. (Inherited from VirtualTimeScheduler<TAbsolute, TRelative>.)
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, Int64, Func<IScheduler, TState, IDisposable>) Schedules an action to be executed at the specified virtual time. (Overrides VirtualTimeScheduler<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 VirtualTimeScheduler<TAbsolute, TRelative>.)
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 Start<T>(Func<IObservable<T>>) Starts the test scheduler.
Public method Start<T>(Func<IObservable<T>>, Int64) Starts the test scheduler.
Public method Start<T>(Func<IObservable<T>>, Int64, Int64, Int64) Starts the test scheduler.
Public method Stop Stops the virtual time scheduler. (Inherited from VirtualTimeSchedulerBase<TAbsolute, TRelative>.)
Protected method ToDateTimeOffset Converts the absolute virtual time value to a DateTimeOffset value. (Overrides VirtualTimeSchedulerBase<TAbsolute, TRelative>.ToDateTimeOffset(TAbsolute).)
Protected method ToRelative Converts the TimeSpan value to a relative virtual time value. (Overrides VirtualTimeSchedulerBase<TAbsolute, TRelative>.ToRelative(TimeSpan).)
Public method ToString (Inherited from Object.)

Top

Extension Methods

  Name Description
Public Extension Method Schedule (Defined by Extensions.)

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

Microsoft.Reactive.Testing Namespace