Class HistoryEventPublisher<TEvent>

Namespace

LfrlAnvil.Reactive

Assembly

LfrlAnvil.Reactive.Core.dll

Represents a generic disposable event source that can be listened to, capable of recording previously published events.

public class HistoryEventPublisher<TEvent> : EventPublisher<TEvent>, IHistoryEventPublisher<TEvent>, IEventPublisher<TEvent>, IEventSource<TEvent>, IEventStream<TEvent>, IEventPublisher, IEventSource, IEventStream, IDisposable

Type Parameters

TEvent

Event type.

Inheritance

object

EventSource<TEvent>

EventPublisher<TEvent>

HistoryEventPublisher<TEvent>

Implements

IHistoryEventPublisher<TEvent>

IEventPublisher<TEvent>

IEventSource<TEvent>

IEventStream<TEvent>

IEventPublisher

IEventSource

IEventStream

IDisposable

Inherited Members

EventPublisher<TEvent>.Publish(TEvent)

EventSource<TEvent>.IsDisposed

EventSource<TEvent>.Subscribers

EventSource<TEvent>.HasSubscribers

EventSource<TEvent>.Listen(IEventListener<TEvent>)

EventSource<TEvent>.Decorate<TNextEvent>(IEventListenerDecorator<TEvent, TNextEvent>)

EventSource<TEvent>.OverrideListenerUnsafe(IEventSubscriber, IEventListener<TEvent>)

EventSource<TEvent>.DisposeCore(out Chain<Exception>)

EventSource<TEvent>.GetCurrentSubscribersUnsafe()

EventSource<TEvent>.NotifyListeners(ArrayPoolToken<IEventSubscriber>, TEvent)

EventSource<TEvent>.TryNotifyListeners(TEvent)

EventSource<TEvent>.ThrowDisposedException()

EventSource<TEvent>.AcquireLock()

EventSource<TEvent>.IsDisposedUnsafe()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EventStreamExtensions.Aggregate<TEvent>(IEventStream<TEvent>, Func<TEvent, TEvent, TEvent>)

EventStreamExtensions.Aggregate<TEvent>(IEventStream<TEvent>, Func<TEvent, TEvent, TEvent>, TEvent)

EventStreamExtensions.Append<TEvent>(IEventStream<TEvent>, IEnumerable<TEvent>)

EventStreamExtensions.Append<TEvent>(IEventStream<TEvent>, params TEvent[])

EventStreamExtensions.AuditUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.BufferUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.Buffer<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.Catch<TEvent, TException>(IEventStream<TEvent>, Action<TException>)

EventStreamExtensions.ContinueWith<TEvent, TNextEvent>(IEventStream<TEvent>, Func<TEvent, IEventStream<TNextEvent>>)

EventStreamExtensions.DebounceUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.DefaultIfEmpty<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.DefaultIfEmpty<TEvent>(IEventStream<TEvent>, TEvent)

EventStreamExtensions.DistinctByUntilChanged<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>)

EventStreamExtensions.DistinctByUntilChanged<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>, IEqualityComparer<TKey>)

EventStreamExtensions.DistinctByUntil<TEvent, TKey, TTargetEvent>(IEventStream<TEvent>, Func<TEvent, TKey>, IEventStream<TTargetEvent>)

EventStreamExtensions.DistinctByUntil<TEvent, TKey, TTargetEvent>(IEventStream<TEvent>, Func<TEvent, TKey>, IEqualityComparer<TKey>, IEventStream<TTargetEvent>)

EventStreamExtensions.DistinctBy<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>)

EventStreamExtensions.DistinctBy<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>, IEqualityComparer<TKey>)

EventStreamExtensions.DistinctUntilChanged<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.DistinctUntilChanged<TEvent>(IEventStream<TEvent>, IEqualityComparer<TEvent>)

EventStreamExtensions.DistinctUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.DistinctUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEqualityComparer<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.Distinct<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Distinct<TEvent>(IEventStream<TEvent>, IEqualityComparer<TEvent>)

EventStreamExtensions.ElementAt<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.First<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Flatten<TSourceEvent, TInnerEvent>(IEventStream<TSourceEvent>, Func<TSourceEvent, IEnumerable<TInnerEvent>>)

EventStreamExtensions.Flatten<TSourceEvent, TInnerEvent, TNextEvent>(IEventStream<TSourceEvent>, Func<TSourceEvent, IEnumerable<TInnerEvent>>, Func<TSourceEvent, TInnerEvent, TNextEvent>)

EventStreamExtensions.ForEach<TEvent>(IEventStream<TEvent>, Action<TEvent>)

EventStreamExtensions.GroupBy<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>)

EventStreamExtensions.GroupBy<TEvent, TKey>(IEventStream<TEvent>, Func<TEvent, TKey>, IEqualityComparer<TKey>)

EventStreamExtensions.Ignore<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Last<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Prepend<TEvent>(IEventStream<TEvent>, IEnumerable<TEvent>)

EventStreamExtensions.Prepend<TEvent>(IEventStream<TEvent>, params TEvent[])

EventStreamExtensions.SampleWhen<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.SelectMany<TSourceEvent, TNextEvent>(IEventStream<TSourceEvent>, Func<TSourceEvent, IEnumerable<TNextEvent>>)

EventStreamExtensions.Select<TSourceEvent, TNextEvent>(IEventStream<TSourceEvent>, Func<TSourceEvent, TNextEvent>)

EventStreamExtensions.Single<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.SkipLast<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.SkipUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.SkipWhile<TEvent>(IEventStream<TEvent>, Func<TEvent, bool>)

EventStreamExtensions.Skip<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.TakeLast<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.TakeUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.TakeWhile<TEvent>(IEventStream<TEvent>, Func<TEvent, bool>)

EventStreamExtensions.Take<TEvent>(IEventStream<TEvent>, int)

EventStreamExtensions.ThrottleUntil<TEvent, TTargetEvent>(IEventStream<TEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.ToAsyncEnumerable<TEvent>(IEventStream<TEvent>, int, bool)

EventStreamExtensions.ToTask<TEvent>(IEventStream<TEvent>, CancellationToken)

EventStreamExtensions.UseSynchronizationContext<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.WhereNotNull<TEvent>(IEventStream<TEvent?>, IEqualityComparer<TEvent>)

EventStreamExtensions.Where<TEvent>(IEventStream<TEvent>, Func<TEvent, bool>)

EventStreamExtensions.WithIndex<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Zip<TSourceEvent, TTargetEvent>(IEventStream<TSourceEvent>, IEventStream<TTargetEvent>)

EventStreamExtensions.Zip<TSourceEvent, TTargetEvent, TNextEvent>(IEventStream<TSourceEvent>, IEventStream<TTargetEvent>, Func<TSourceEvent, TTargetEvent, TNextEvent>)

Constructors

HistoryEventPublisher(int)

Creates a new HistoryEventPublisher<TEvent> instance.

public HistoryEventPublisher(int capacity)

Parameters

capacity int

Specifies the maximum number of events this event publisher can record.

Exceptions

ArgumentOutOfRangeException

When capacity is less than 1.

Properties

Capacity

Specifies the maximum number of events this event publisher can record.

public int Capacity { get; }

Property Value

int

History

Collection of recorded previously published events.

public TEvent[] History { get; }

Property Value

TEvent[]

Methods

ClearHistory()

Removes all recorded events.

public void ClearHistory()

Dispose()

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

public override void Dispose()

OnPublish(TEvent)

Allows to react to event publishing.

protected override void OnPublish(TEvent @event)

Parameters

event TEvent

Event to publish.

OnSubscriberAddedUnsafe(IEventSubscriber, IEventListener<TEvent>)

Allows to react to attachment of a new event subscriber.

protected override void OnSubscriberAddedUnsafe(IEventSubscriber subscriber, IEventListener<TEvent> listener)

Parameters

subscriber IEventSubscriber

Attached event subscriber.

listener IEventListener<TEvent>

Event listener attached to the event subscriber.

Remarks

This method call is not thread-safe by default.

OnSubscriberRegistered(IEventSubscriber, IEventListener<TEvent>)

Allows to override an event listener after subscriber has been registered.

protected override IEventListener<TEvent> OnSubscriberRegistered(IEventSubscriber subscriber, IEventListener<TEvent> listener)

Parameters

subscriber IEventSubscriber

Event subscriber.

listener IEventListener<TEvent>

Event listener to override.

Returns

IEventListener<TEvent>

IEventListener<TEvent> instance.

StartHistoryListener(IEventListener<TEvent>)

Starts an internal history listener.

protected void StartHistoryListener(IEventListener<TEvent> listener)

Parameters

listener IEventListener<TEvent>

Listener to start.

Exceptions

InvalidCastException

When listener is not a history listener returned by OnSubscriberRegistered(IEventSubscriber, IEventListener<TEvent>) method.