ObservingSchedulerType

PackageFCQRS
Scheduler wrapper that exposes enqueue/cancel events with optional names

Specification

Kind
Type
Members
15
Examples
0
``.ctor``Signature
ObservingScheduler(config, log)
AdvanceSignature
this.Advance
AdvanceToSignature
this.AdvanceTo
CancelSignature
this.Cancel
ScheduleOnceSignature
this.ScheduleOnce

Summary

NameSignatureSynopsis
``.ctor``ObservingScheduler(config, log)No description available.
Advancethis.AdvanceDrive the virtual clock forward.
AdvanceTothis.AdvanceToNo description available.
Cancelthis.CancelCancel via wrapper with name
ScheduleOncethis.ScheduleOnceFallback ScheduleOnce without name
ScheduleOncethis.ScheduleOnceSchedule a one-time action with optional name
ScheduleRepeatedlythis.ScheduleRepeatedlyFallback ScheduleRepeatedly without name
ScheduleRepeatedlythis.ScheduleRepeatedlySchedule a repeated action with optional name
ScheduleTellOncethis.ScheduleTellOnceFallback ScheduleTellOnce without name
ScheduleTellOncethis.ScheduleTellOnceSchedule a one-time Tell with optional name
ScheduleTellRepeatedlythis.ScheduleTellRepeatedlyFallback ScheduleTellRepeatedly without name
ScheduleTellRepeatedlythis.ScheduleTellRepeatedlySchedule repeated Tell with optional name
Nowthis.NowThe virtual clock's current time.
OnEnqueuedthis.OnEnqueuedFired whenever a ScheduledItem is enqueued
OnCancelledthis.OnCancelledFired whenever a ScheduledItem is cancelled

``.ctor``

ObservingScheduler(config, log)
Member

Parameters

NameTypeDescription
configConfig
logILoggingAdapter

Returns

ObservingScheduler

Advance

this.Advance
Member
Drive the virtual clock forward. TestScheduler.Advance is NOT thread-safe (racy clock update + snapshot/execute/remove), and the controller agent advances on its own thread — serialize all advances through this lock or a due item can be delivered twice.

Parameters

NameTypeDescription
dTimeSpan

Returns

unit

AdvanceTo

this.AdvanceTo
Member

Parameters

NameTypeDescription
deadlineDateTimeOffset

Returns

unit

Cancel

this.Cancel
Member
Cancel via wrapper with name

Parameters

NameTypeDescription
cancelableICancelable
namestring option

Returns

unit

ScheduleOnce

this.ScheduleOnce
Member
Fallback ScheduleOnce without name

Parameters

NameTypeDescription
delayTimeSpan
actionunit -> unit

Returns

ICancelable

ScheduleOnce

this.ScheduleOnce
Member
Schedule a one-time action with optional name

Parameters

NameTypeDescription
namestring option
delayTimeSpan
actionunit -> unit

Returns

ICancelable

ScheduleRepeatedly

this.ScheduleRepeatedly
Member
Fallback ScheduleRepeatedly without name

Parameters

NameTypeDescription
initialDelayTimeSpan
intervalTimeSpan
actionunit -> unit

Returns

ICancelable

ScheduleRepeatedly

this.ScheduleRepeatedly
Member
Schedule a repeated action with optional name

Parameters

NameTypeDescription
namestring option
initialDelayTimeSpan
intervalTimeSpan
actionunit -> unit

Returns

ICancelable

ScheduleTellOnce

this.ScheduleTellOnce
Member
Fallback ScheduleTellOnce without name

Parameters

NameTypeDescription
delayTimeSpan
receiverICanTell
messageobj
senderIActorRef

Returns

ICancelable

ScheduleTellOnce

this.ScheduleTellOnce
Member
Schedule a one-time Tell with optional name

Parameters

NameTypeDescription
namestring option
delayTimeSpan
receiverICanTell
messageobj
senderIActorRef

Returns

ICancelable

ScheduleTellRepeatedly

this.ScheduleTellRepeatedly
Member
Fallback ScheduleTellRepeatedly without name

Parameters

NameTypeDescription
initialDelayTimeSpan
intervalTimeSpan
receiverICanTell
messageobj
senderIActorRef

Returns

ICancelable

ScheduleTellRepeatedly

this.ScheduleTellRepeatedly
Member
Schedule repeated Tell with optional name

Parameters

NameTypeDescription
namestring option
initialDelayTimeSpan
intervalTimeSpan
receiverICanTell
messageobj
senderIActorRef

Returns

ICancelable

Now

this.Now
Member
The virtual clock's current time.

Returns

DateTimeOffset

OnEnqueued

this.OnEnqueued
Member
Fired whenever a ScheduledItem is enqueued

Returns

IEvent<string option * TimeSpan * (unit -> unit)>

OnCancelled

this.OnCancelled
Member
Fired whenever a ScheduledItem is cancelled

Returns

IEvent<string option * TimeSpan * (unit -> unit)>