Class HistoricalScheduler

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

Inheritance

Object

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>

HistoricalSchedulerBase

HistoricalScheduler

Implements

IScheduler

IServiceProvider

IStopwatchProvider

Inherited Members

HistoricalSchedulerBase.Add(DateTimeOffset, TimeSpan)

HistoricalSchedulerBase.ToDateTimeOffset(DateTimeOffset)

HistoricalSchedulerBase.ToRelative(TimeSpan)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Add(DateTimeOffset, TimeSpan)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.ToDateTimeOffset(DateTimeOffset)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.ToRelative(TimeSpan)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.IsEnabled

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Comparer

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.ScheduleAbsolute<TState>(TState, DateTimeOffset, Func<IScheduler, TState, IDisposable>)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.ScheduleRelative<TState>(TState, TimeSpan, Func<IScheduler, TState, IDisposable>)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Schedule<TState>(TState, Func<IScheduler, TState, IDisposable>)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Schedule<TState>(TState, TimeSpan, Func<IScheduler, TState, IDisposable>)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Schedule<TState>(TState, DateTimeOffset, Func<IScheduler, TState, IDisposable>)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Start()

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Stop()

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.AdvanceTo(DateTimeOffset)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.AdvanceBy(TimeSpan)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Sleep(TimeSpan)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Clock

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.Now

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.GetNext()

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.IServiceProvider.GetService(Type)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.GetService(Type)

VirtualTimeSchedulerBase<DateTimeOffset, TimeSpan>.StartStopwatch()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Object.ReferenceEquals(Object, Object)

Namespace: System.Reactive.Concurrency

Assembly: System.Reactive.Linq.dll

Syntax

public class HistoricalScheduler : HistoricalSchedulerBase, IScheduler, IServiceProvider, IStopwatchProvider

Constructors

HistoricalScheduler()

Creates a new historical scheduler with the minimum value of DateTimeOffset as the initial clock value.

Declaration

public HistoricalScheduler()

HistoricalScheduler(DateTimeOffset)

Creates a new historical scheduler with the specified initial clock value.

Declaration

public HistoricalScheduler(DateTimeOffset initialClock)

Parameters

Type	Name	Description
DateTimeOffset	initialClock	Initial value for the clock.

HistoricalScheduler(DateTimeOffset, IComparer<DateTimeOffset>)

Creates a new historical scheduler with the specified initial clock value.

Declaration

public HistoricalScheduler(DateTimeOffset initialClock, IComparer<DateTimeOffset> comparer)

Parameters

Type	Name	Description
DateTimeOffset	initialClock	Initial value for the clock.
IComparer<DateTimeOffset>	comparer	Comparer to determine causality of events based on absolute time.

Exceptions

Type	Condition
ArgumentNullException	comparer is null.

Methods

GetNext()

Gets the next scheduled item to be executed.

Declaration

protected override IScheduledItem<DateTimeOffset> GetNext()

Returns

Type	Description
IScheduledItem<DateTimeOffset>	The next scheduled item.

Overrides

System.Reactive.Concurrency.VirtualTimeSchedulerBase<System.DateTimeOffset, System.TimeSpan>.GetNext()

ScheduleAbsolute<TState>(TState, DateTimeOffset, Func<IScheduler, TState, IDisposable>)

Schedules an action to be executed at dueTime.

Declaration

public override IDisposable ScheduleAbsolute<TState>(TState state, DateTimeOffset dueTime, Func<IScheduler, TState, IDisposable> action)

Parameters

Type	Name	Description
TState	state	State passed to the action to be executed.
DateTimeOffset	dueTime	Absolute time at which to execute the action.
Func<IScheduler, TState, IDisposable>	action	Action to be executed.

Returns

Type	Description
IDisposable	The disposable object used to cancel the scheduled action (best effort).

Type Parameters

Name	Description
TState	The type of the state passed to the scheduled action.

Overrides

System.Reactive.Concurrency.VirtualTimeSchedulerBase<System.DateTimeOffset, System.TimeSpan>.ScheduleAbsolute<TState>(TState, System.DateTimeOffset, System.Func<System.Reactive.Concurrency.IScheduler, TState, System.IDisposable>)

Exceptions

Type	Condition
ArgumentNullException	action is null.

Implements

IScheduler

System.IServiceProvider

IStopwatchProvider

Extension Methods

VirtualTimeSchedulerExtensions.ScheduleRelative<TAbsolute, TRelative>(VirtualTimeSchedulerBase<TAbsolute, TRelative>, TRelative, Action)

VirtualTimeSchedulerExtensions.ScheduleAbsolute<TAbsolute, TRelative>(VirtualTimeSchedulerBase<TAbsolute, TRelative>, TAbsolute, Action)

Scheduler.DisableOptimizations(IScheduler)

Scheduler.DisableOptimizations(IScheduler, Type[])

Scheduler.Catch<TException>(IScheduler, Func<TException, Boolean>)

Scheduler.SchedulePeriodic<TState>(IScheduler, TState, TimeSpan, Func<TState, TState>)

Scheduler.SchedulePeriodic<TState>(IScheduler, TState, TimeSpan, Action<TState>)

Scheduler.SchedulePeriodic(IScheduler, TimeSpan, Action)

Scheduler.StartStopwatch(IScheduler)

Scheduler.AsLongRunning(IScheduler)

Scheduler.AsStopwatchProvider(IScheduler)

Scheduler.AsPeriodic(IScheduler)

Scheduler.Schedule(IScheduler, Action<Action>)

Scheduler.Schedule<TState>(IScheduler, TState, Action<TState, Action<TState>>)

Scheduler.Schedule(IScheduler, TimeSpan, Action<Action<TimeSpan>>)

Scheduler.Schedule<TState>(IScheduler, TState, TimeSpan, Action<TState, Action<TState, TimeSpan>>)

Scheduler.Schedule(IScheduler, DateTimeOffset, Action<Action<DateTimeOffset>>)

Scheduler.Schedule<TState>(IScheduler, TState, DateTimeOffset, Action<TState, Action<TState, DateTimeOffset>>)

Scheduler.Schedule(IScheduler, Action)

Scheduler.Schedule(IScheduler, TimeSpan, Action)

Scheduler.Schedule(IScheduler, DateTimeOffset, Action)