Class Group

This class provides base functionality for all group routers in the system. Group routers are routers that use already created routees. These routees are supplied to the router and are addressed through ActorSelection paths.

Inheritance
object
RouterConfig
Group
AdaptiveLoadBalancingGroup
ClusterRouterGroup
BroadcastGroup
ConsistentHashingGroup
RandomGroup
RoundRobinGroup
ScatterGatherFirstCompletedGroup
TailChoppingGroup
Implements
Inherited Members
Namespace: Akka.Routing
Assembly: Akka.dll
Syntax
public abstract class Group : RouterConfig, ISurrogated, IEquatable<RouterConfig>, IEquatable<Group>

Constructors

| Edit this page View Source

Group(IEnumerable<string>, string)

TBD

Declaration
protected Group(IEnumerable<string> paths, string routerDispatcher)
Parameters
Type Name Description
IEnumerable<string> paths

TBD
string routerDispatcher

TBD

Fields

| Edit this page View Source

InternalPaths

Internal property for holding the supplied paths

Declaration
protected readonly string[] InternalPaths
Field Value
Type Description
string[]

Methods

| Edit this page View Source

CreateRouterActor()

TBD

Declaration
public override ActorBase CreateRouterActor()
Returns
Type Description
ActorBase

TBD
Overrides
Akka.Routing.RouterConfig.CreateRouterActor()
| Edit this page View Source

Equals(Group)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(Group other)
Parameters
Type Name Description
Group other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
| Edit this page View Source

GetPaths(ActorSystem)

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

Declaration
public abstract 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
| Edit this page View Source

Props()

Adds the current router to an empty Props.

Declaration
public Props Props()
Returns
Type Description
Props

An empty Props configured to use the current router.

Implements

Extension Methods