Search Results for

    Show / Hide Table of Contents

    Class EventStream

    The EventStream is a pub-sub stream of events that can be both system and user generated.

    The subscribers are IActorRef instances and events can be any object. Subscriptions are hierarchical meaning that if you listen to an event for a particular type you will receive events for that type and any sub types.

    If the debug flag is activated any operations on the event stream will be published as debug level events.

    Inheritance
    object
    EventBus<object, Type, IActorRef>
    ActorEventBus<object, Type>
    LoggingBus
    EventStream
    Inherited Members
    LoggingBus.LogLevel
    LoggingBus.IsSubClassification(Type, Type)
    LoggingBus.Publish(object, IActorRef)
    LoggingBus.Classify(object, Type)
    LoggingBus.GetClassifier(object)
    LoggingBus.StartStdoutLogger(Settings)
    LoggingBus.SetLogLevel(LogLevel)
    EventBus<object, Type, IActorRef>.SimpleName(object)
    EventBus<object, Type, IActorRef>.SimpleName(Type)
    EventBus<object, Type, IActorRef>.Subscribe(IActorRef, Type)
    EventBus<object, Type, IActorRef>.Unsubscribe(IActorRef)
    EventBus<object, Type, IActorRef>.Unsubscribe(IActorRef, Type)
    EventBus<object, Type, IActorRef>.IsSubClassification(Type, Type)
    EventBus<object, Type, IActorRef>.Publish(object, IActorRef)
    EventBus<object, Type, IActorRef>.Classify(object, Type)
    EventBus<object, Type, IActorRef>.GetClassifier(object)
    EventBus<object, Type, IActorRef>.Publish(object)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Event
    Assembly: Akka.dll
    Syntax
    public class EventStream : LoggingBus

    Constructors

    | Edit this page View Source

    EventStream(bool)

    Initializes a new instance of the EventStream class.

    Declaration
    public EventStream(bool debug)
    Parameters
    Type Name Description
    bool debug

    if set to true [debug].

    Methods

    | Edit this page View Source

    StartUnsubscriber(ActorSystemImpl)

    Used to start the Unsubscriber actor, responsible for garabage-collecting all expired subscriptions when the subscribed actor terminates.

    Declaration
    public void StartUnsubscriber(ActorSystemImpl system)
    Parameters
    Type Name Description
    ActorSystemImpl system

    TBD

    | Edit this page View Source

    Subscribe(IActorRef, Type)

    Subscribes the specified subscriber.

    Declaration
    public override bool Subscribe(IActorRef subscriber, Type channel)
    Parameters
    Type Name Description
    IActorRef subscriber

    The subscriber.

    Type channel

    The channel.

    Returns
    Type Description
    bool

    true if subscription was successful, false otherwise.

    Overrides
    EventBus<object, Type, IActorRef>.Subscribe(IActorRef, Type)
    Exceptions
    Type Condition
    ArgumentNullException

    This exception is thrown if the given subscriber is undefined.

    | Edit this page View Source

    Unsubscribe(IActorRef)

    Unsubscribes the specified subscriber.

    Declaration
    public override bool Unsubscribe(IActorRef subscriber)
    Parameters
    Type Name Description
    IActorRef subscriber

    The subscriber.

    Returns
    Type Description
    bool

    true if unsubscription was successful, false otherwise.

    Overrides
    EventBus<object, Type, IActorRef>.Unsubscribe(IActorRef)
    Exceptions
    Type Condition
    ArgumentNullException

    This exception is thrown if the given subscriber is undefined.

    | Edit this page View Source

    Unsubscribe(IActorRef, Type)

    Unsubscribes the specified subscriber.

    Declaration
    public override bool Unsubscribe(IActorRef subscriber, Type channel)
    Parameters
    Type Name Description
    IActorRef subscriber

    The subscriber.

    Type channel

    The channel.

    Returns
    Type Description
    bool

    true if unsubscription was successful, false otherwise.

    Overrides
    EventBus<object, Type, IActorRef>.Unsubscribe(IActorRef, Type)
    Exceptions
    Type Condition
    ArgumentNullException

    This exception is thrown if the given subscriber is undefined.

    Extension Methods

    EventStreamExtensions.Subscribe<TChannel>(EventStream, IActorRef)
    EventStreamExtensions.Unsubscribe<TChannel>(EventStream, IActorRef)
    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET