Class EventStreamExtensions

Extension methods for the EventStream class.

Inheritance

object

EventStreamExtensions

Inherited Members

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 static class EventStreamExtensions

Methods

Subscribe<TChannel>(EventStream, IActorRef)

Subscribes the specified subscriber.

Declaration

public static bool Subscribe<TChannel>(this EventStream eventStream, IActorRef subscriber)

Parameters

Type	Name	Description
EventStream	eventStream	The event stream.
IActorRef	subscriber	The subscriber.

Returns

Type	Description
bool	true if subscription was successful, false otherwise.

Type Parameters

Name	Description
TChannel	The channel.

Exceptions

Type	Condition
ArgumentNullException	subscriber

Unsubscribe<TChannel>(EventStream, IActorRef)

Unsubscribes the specified subscriber.

Declaration

public static bool Unsubscribe<TChannel>(this EventStream eventStream, IActorRef subscriber)

Parameters

Type	Name	Description
EventStream	eventStream	The event stream.
IActorRef	subscriber	The subscriber.

Returns

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

Type Parameters

Name	Description
TChannel	The channel.

Exceptions

Type	Condition
ArgumentNullException	subscriber