Class ListenerSupport

This class adds IListeners capabilities to an actor.

note

ListenerReceive must be wired manually into the actor's OnReceive(object) method.

Inheritance

object

ListenerSupport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Routing

Assembly: Akka.dll

Syntax

public class ListenerSupport

Fields

Listeners

The collection of registered listeners that is listening for messages from an actor.

Declaration

protected readonly HashSet<IActorRef> Listeners

Field Value

Type	Description
HashSet<IActorRef>

Properties

ListenerReceive

Retrieves the wiring needed to implement listening functionality.

note

This needs to be chained into the actor's OnReceive(object) method.

Declaration

public Receive ListenerReceive { get; }

Property Value

Type	Description
Receive

Methods

Add(IActorRef)

Adds the specified actor to the collection of registered listeners.

Declaration

public void Add(IActorRef actor)

Parameters

Type	Name	Description
IActorRef	actor	The actor to add to the collection of registered listeners.

Gossip(object)

Sends the supplied message to all registered listeners.

note

Messages sent this way use NoSender as the sender.

Declaration

public void Gossip(object message)

Parameters

Type	Name	Description
object	message	The message sent to all registered listeners.

Gossip(object, IActorRef)

Sends the supplied message to all registered listeners.

Declaration

public void Gossip(object message, IActorRef sender)

Parameters

Type	Name	Description
object	message	The message sent to all registered listeners.
IActorRef	sender	The actor that sends the message.

Remove(IActorRef)

Removes the specified actor from the collection of registered listeners.

Declaration

public void Remove(IActorRef actor)

Parameters

Type	Name	Description
IActorRef	actor	The actor to remove from the collection of registered listeners.

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)