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

EventStream(Boolean)

Initializes a new instance of the EventStream class.

Declaration

public EventStream(bool debug)

Parameters

Type	Name	Description
Boolean	debug	if set to true [debug].

Methods

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

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
Boolean	true if subscription was successful, false otherwise.

Overrides

Akka.Event.EventBus<System.Object, System.Type, Akka.Actor.IActorRef>.Subscribe(Akka.Actor.IActorRef, System.Type)

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the given subscriber is undefined.

Unsubscribe(IActorRef)

Unsubscribes the specified subscriber.

Declaration

public override bool Unsubscribe(IActorRef subscriber)

Parameters

Type	Name	Description
IActorRef	subscriber	The subscriber.

Returns

Type	Description
Boolean	true if unsubscription was successful, false otherwise.

Overrides

Akka.Event.EventBus<System.Object, System.Type, Akka.Actor.IActorRef>.Unsubscribe(Akka.Actor.IActorRef)

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the given subscriber is undefined.

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
Boolean	true if unsubscription was successful, false otherwise.

Overrides

Akka.Event.EventBus<System.Object, System.Type, Akka.Actor.IActorRef>.Unsubscribe(Akka.Actor.IActorRef, System.Type)

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the given subscriber is undefined.

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

EventStreamExtensions.Subscribe<TChannel>(EventStream, IActorRef)

EventStreamExtensions.Unsubscribe<TChannel>(EventStream, IActorRef)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)