Class ReactiveTimer

Namespace

LfrlAnvil.Reactive.Chrono

Assembly

LfrlAnvil.Reactive.Chrono.dll

Represents a disposable timer that can be listened to.

public sealed class ReactiveTimer : ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>, IEventSource<WithInterval<long>>, IEventStream<WithInterval<long>>, IEventSource, IEventStream, IDisposable

Inheritance

object

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>

ReactiveTimer

Implements

IEventSource<WithInterval<long>>

IEventStream<WithInterval<long>>

IEventSource

IEventStream

IDisposable

Inherited Members

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.IsDisposed

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.Subscribers

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.HasSubscribers

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.Dispose()

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.Decorate<TNextEvent>(IEventListenerDecorator<WithInterval<long>, TNextEvent>)

ConcurrentEventSource<WithInterval<long>, EventPublisher<WithInterval<long>>>.Listen(IEventListener<WithInterval<long>>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EventStreamExtensions.Delay<TEvent>(IEventStream<TEvent>, ITimestampProvider, Duration)

EventStreamExtensions.Delay<TEvent>(IEventStream<TEvent>, ITimestampProvider, Duration, Duration)

EventStreamExtensions.Delay<TEvent>(IEventStream<TEvent>, ITimestampProvider, Duration, TaskFactory)

EventStreamExtensions.Delay<TEvent>(IEventStream<TEvent>, ITimestampProvider, Duration, TaskFactory, Duration)

EventStreamExtensions.RegisterTasks<TKey>(IEventStream<WithInterval<long>>, IEnumerable<ITimerTask<TKey>>)

EventStreamExtensions.WithInterval<TEvent>(IEventStream<TEvent>, ITimestampProvider)

EventStreamExtensions.WithTimestamp<TEvent>(IEventStream<TEvent>, ITimestampProvider)

EventStreamExtensions.WithZonedDateTime<TEvent>(IEventStream<TEvent>, IZonedClock)

Constructors

ReactiveTimer(ITimestampProvider, Duration, Duration, long)

Creates a new ReactiveTimer instance.

public ReactiveTimer(ITimestampProvider timestampProvider, Duration interval, Duration spinWaitDurationHint, long count = 9223372036854775807)

Parameters

timestampProvider ITimestampProvider

Timestamp provider used for time tracking.

interval Duration

Interval between subsequent timer events.

spinWaitDurationHint Duration

SpinWait duration hint for this timer.

count long

Number of events this timer will emit in total. Equal to MaxValue by default.

Exceptions

ArgumentOutOfRangeException

When count is less than 1 or when interval is less than 1 tick or greater than MaxValue milliseconds or when spinWaitDurationHint is less than 0.

ReactiveTimer(ITimestampProvider, Duration, long)

Creates a new ReactiveTimer instance.

public ReactiveTimer(ITimestampProvider timestampProvider, Duration interval, long count = 9223372036854775807)

Parameters

timestampProvider ITimestampProvider

Timestamp provider used for time tracking.

interval Duration

Interval between subsequent timer events.

count long

Number of events this timer will emit in total. Equal to MaxValue by default.

Exceptions

ArgumentOutOfRangeException

When count is less than 1 or when interval is less than 1 tick or greater than MaxValue milliseconds.

Fields

DefaultSpinWaitDurationHint

Specifies the default SpinWait duration hint. Equal to 1 microsecond.

public static readonly Duration DefaultSpinWaitDurationHint

Field Value

Duration

Properties

Count

Number of events this timer will emit in total.

public long Count { get; }

Property Value

long

Interval

Interval between subsequent timer events.

public Duration Interval { get; }

Property Value

Duration

State

Specifies the current state of this timer.

public ReactiveTimerState State { get; }

Property Value

ReactiveTimerState

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public override void Dispose()

Run()

Attempts to run this timer.

public void Run()

Exceptions

ObjectDisposedException

The timer has been disposed.

InvalidOperationException

The timer is not in Idle state.

Run(Duration)

Attempts to run this timer with an initial delay.

public void Run(Duration delay)

Parameters

delay Duration

Time that must elapse before emitting the first event.

Exceptions

ObjectDisposedException

The timer has been disposed.

InvalidOperationException

The timer is not in Idle state.

ArgumentOutOfRangeException

When delay is less than 1 tick or greater than MaxValue milliseconds.

Stop()

Attempts to stop this timer.

public bool Stop()

Returns

bool

true when timer was marked for stopping, otherwise false.