Class BroadcastGroup

This class represents a Group router that sends messages it receives to all of its routees.

Inheritance
object
RouterConfig
Group
BroadcastGroup
Implements
Inherited Members
Namespace: Akka.Routing
Assembly: Akka.dll
Syntax
public sealed class BroadcastGroup : Group, ISurrogated, IEquatable<RouterConfig>, IEquatable<Group>

Constructors

| Edit this page View Source

BroadcastGroup(Config)

Initializes a new instance of the BroadcastGroup class.

note

If 'routees.path' is defined in the provided configuration then those paths will be used by the router.

Declaration
public BroadcastGroup(Config config)
Parameters
Type Name Description
Config config

The configuration to use to lookup paths used by the group router.
| Edit this page View Source

BroadcastGroup(IEnumerable<string>)

Initializes a new instance of the BroadcastGroup class.

Declaration
public BroadcastGroup(IEnumerable<string> paths)
Parameters
Type Name Description
IEnumerable<string> paths

An enumeration of actor paths used by the group router.
| Edit this page View Source

BroadcastGroup(IEnumerable<string>, string)

Initializes a new instance of the BroadcastGroup class.

Declaration
public BroadcastGroup(IEnumerable<string> paths, string routerDispatcher)
Parameters
Type Name Description
IEnumerable<string> paths

An enumeration of actor paths used by the group router.
string routerDispatcher

The dispatcher to use when passing messages to the routees.
| Edit this page View Source

BroadcastGroup(params string[])

Initializes a new instance of the BroadcastGroup class.

Declaration
public BroadcastGroup(params string[] paths)
Parameters
Type Name Description
string[] paths

A list of actor paths used by the group router.

Methods

| Edit this page View Source

CreateRouter(ActorSystem)

Creates a router that is responsible for routing messages to routees within the provided system.

Declaration
public override Router CreateRouter(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The actor system that owns this router.
Returns
Type Description
Router

The newly created router tied to the given system.
Overrides
| Edit this page View Source

GetPaths(ActorSystem)

Retrieves the actor paths used by this router during routee selection.

Declaration
public override IEnumerable<string> GetPaths(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The actor system that owns this router.
Returns
Type Description
IEnumerable<string>

An enumeration of actor paths used during routee selection
Overrides
| Edit this page View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current BroadcastGroup.

Declaration
public override ISurrogate ToSurrogate(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The actor system that owns this router.
Returns
Type Description
ISurrogate

The surrogate representation of the current BroadcastGroup.
Overrides
| Edit this page View Source

WithDispatcher(string)

Creates a new BroadcastGroup router with a given dispatcher id.

note

This method is immutable and returns a new instance of the router.

Declaration
public Group WithDispatcher(string dispatcher)
Parameters
Type Name Description
string dispatcher

The dispatcher id used to configure the new router.
Returns
Type Description
Group

A new router with the provided dispatcher id.

Implements

Extension Methods