Class EventSource<TEvent>

Namespace

LfrlAnvil.Reactive

Assembly

LfrlAnvil.Reactive.Core.dll

Represents a generic disposable event source that can be listened to.

public abstract class EventSource<TEvent> : IEventSource<TEvent>, IEventStream<TEvent>, IEventSource, IEventStream, IDisposable

Type Parameters

TEvent

Event type.

Inheritance

object

EventSource<TEvent>

Implements

IEventSource<TEvent>

IEventStream<TEvent>

IEventSource

IEventStream

IDisposable

Derived

IntervalEventSource

EventHandlerSource<TEvent>

EventPublisher<TEvent>

CombineEventSource<TEvent>

EnumerableEventSource<TEvent>

MergeEventSource<TEvent>

TaskEventSource<TEvent>

WhenAllEventSource<TEvent>

WhenAnyEventSource<TEvent>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EventStreamExtensions.ToConcurrent<TEvent>(EventSource<TEvent>)

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.Concurrent<TEvent>(IEventStream<TEvent>)

EventStreamExtensions.Concurrent<TEvent>(IEventStream<TEvent>, object)

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.ShareConcurrencyWith<TEvent, TTargetEvent, TResult>(IEventStream<TEvent>, IEventStream<TTargetEvent>, Func<IEventStream<TEvent>, IEventStream<TTargetEvent>, TResult>)

EventStreamExtensions.ShareConcurrencyWith<TEvent, TTargetEvent, TResult>(IEventStream<TEvent>, IEventStream<TTargetEvent>, Func<IEventStream<TEvent>, IEventStream<TTargetEvent>, TResult>, object)

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.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

EventSource()

Creates a new EventSource<TEvent> instance.

protected EventSource()

Properties

HasSubscribers

Specifies whether or not this event source has any event subscribers.

public bool HasSubscribers { get; }

Property Value

bool

IsDisposed

Specifies whether or not this event stream has been disposed.

public bool IsDisposed { get; }

Property Value

bool

Subscribers

Collection of currently attached event subscribers to this event source.

public IReadOnlyCollection<IEventSubscriber> Subscribers { get; }

Property Value

IReadOnlyCollection<IEventSubscriber>

Methods

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

Creates a new decorated IEventStream<TEvent> instance.

[Pure]
public IEventStream<TNextEvent> Decorate<TNextEvent>(IEventListenerDecorator<TEvent, TNextEvent> decorator)

Parameters

decorator IEventListenerDecorator<TEvent, TNextEvent>

Event listener decorator.

Returns

IEventStream<TNextEvent>

Decorated IEventStream<TEvent> instance.

Type Parameters

TNextEvent

Next event type.

Dispose()

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

public void Dispose()

EnsureNotDisposed()

Throws an exception when this event source has been disposed.

protected void EnsureNotDisposed()

Exceptions

ObjectDisposedException

When this event source has been disposed.

Listen(IEventListener<TEvent>)

Attaches the provided listener to this event stream.

public IEventSubscriber Listen(IEventListener<TEvent> listener)

Parameters

listener IEventListener<TEvent>

Event listener to attach.

Returns

IEventSubscriber

New IEventSubscriber instance that can be used to detach the listener.

NotifyListeners(TEvent)

Allows to notify all current event listeners that an event has occurred.

protected void NotifyListeners(TEvent @event)

Parameters

event TEvent

Event to notify with.

OnDispose()

Allows to provide custom disposal implementation.

protected virtual void OnDispose()

OnSubscriberAdded(IEventSubscriber, IEventListener<TEvent>)

Allows to react to attachment of a new event subscriber.

protected virtual void OnSubscriberAdded(IEventSubscriber subscriber, IEventListener<TEvent> listener)

Parameters

subscriber IEventSubscriber

Attached event subscriber.

listener IEventListener<TEvent>

Event listener attached to the event subscriber.

OverrideListener(IEventSubscriber, IEventListener<TEvent>)

Allows to override the event listener.

protected virtual IEventListener<TEvent> OverrideListener(IEventSubscriber subscriber, IEventListener<TEvent> listener)

Parameters

subscriber IEventSubscriber

Event subscriber.

listener IEventListener<TEvent>

Event listener to override.

Returns

IEventListener<TEvent>

IEventListener<TEvent> instance.