Package org.apache.pekko.routing

Class Router

java.lang.Object

org.apache.pekko.routing.Router

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public final class Router
extends java.lang.Object
implements scala.Product, java.io.Serializable

For each message that is sent through the router via the route(java.lang.Object, org.apache.pekko.actor.ActorRef) method the RoutingLogic decides to which Routee to send the message. The Routee itself knows how to perform the actual sending. Normally the RoutingLogic picks one of the contained routees, but that is up to the implementation of the RoutingLogic.

A Router is immutable and the RoutingLogic must be thread safe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Router(RoutingLogic logic)	Java API
Router(RoutingLogic logic, java.lang.Iterable<Routee> routees)	Java API
Router(RoutingLogic logic, scala.collection.immutable.IndexedSeq<Routee> routees)

Method Summary

Modifier and Type	Method	Description
static scala.collection.immutable.IndexedSeq<Routee>	$lessinit$greater$default$2()
Router	addRoutee(ActorRef ref)	Create a new instance with one more ActorRefRoutee for the specified pekko.actor.ActorRef and the same RoutingLogic.
Router	addRoutee(ActorSelection sel)	Create a new instance with one more ActorSelectionRoutee for the specified pekko.actor.ActorSelection and the same RoutingLogic.
Router	addRoutee(Routee routee)	Create a new instance with one more routee and the same RoutingLogic.
static Router	apply(RoutingLogic logic, scala.collection.immutable.IndexedSeq<Routee> routees)
static scala.collection.immutable.IndexedSeq<Routee>	apply$default$2()
boolean	canEqual(java.lang.Object x$1)
Router	copy(RoutingLogic logic, scala.collection.immutable.IndexedSeq<Routee> routees)
RoutingLogic	copy$default$1()
scala.collection.immutable.IndexedSeq<Routee>	copy$default$2()
boolean	equals(java.lang.Object x$1)
int	hashCode()
RoutingLogic	logic()
int	productArity()
java.lang.Object	productElement(int x$1)
java.lang.String	productElementName(int x$1)
scala.collection.Iterator<java.lang.Object>	productIterator()
java.lang.String	productPrefix()
Router	removeRoutee(ActorRef ref)	Create a new instance without the ActorRefRoutee for the specified pekko.actor.ActorRef.
Router	removeRoutee(ActorSelection sel)	Create a new instance without the ActorSelectionRoutee for the specified pekko.actor.ActorSelection.
Router	removeRoutee(Routee routee)	Create a new instance without the specified routee.
void	route(java.lang.Object message, ActorRef sender)	Send the message to the destination Routee selected by the RoutingLogic.
scala.collection.immutable.IndexedSeq<Routee>	routees()
java.lang.String	toString()
static scala.Option<scala.Tuple2<RoutingLogic,scala.collection.immutable.IndexedSeq<Routee>>>	unapply(Router x$0)
Router	withRoutees(scala.collection.immutable.IndexedSeq<Routee> rs)	Create a new instance with the specified routees and the same RoutingLogic.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productElementNames

Constructor Detail

Router

public Router(RoutingLogic logic,
              scala.collection.immutable.IndexedSeq<Routee> routees)

Router

public Router(RoutingLogic logic)

Java API

Router

public Router(RoutingLogic logic,
              java.lang.Iterable<Routee> routees)

Java API

Method Detail

$lessinit$greater$default$2

public static scala.collection.immutable.IndexedSeq<Routee> $lessinit$greater$default$2()

apply

public static Router apply(RoutingLogic logic,
                           scala.collection.immutable.IndexedSeq<Routee> routees)

apply$default$2

public static scala.collection.immutable.IndexedSeq<Routee> apply$default$2()

unapply

public static scala.Option<scala.Tuple2<RoutingLogic,scala.collection.immutable.IndexedSeq<Routee>>> unapply(Router x$0)

logic

public RoutingLogic logic()

routees

public scala.collection.immutable.IndexedSeq<Routee> routees()

route

public void route(java.lang.Object message,
                  ActorRef sender)

Send the message to the destination Routee selected by the RoutingLogic. If the message is a pekko.routing.RouterEnvelope it will be unwrapped before sent to the destinations. Messages wrapped in a Broadcast envelope are always sent to all routees.

withRoutees

public Router withRoutees(scala.collection.immutable.IndexedSeq<Routee> rs)

Create a new instance with the specified routees and the same RoutingLogic.

addRoutee

public Router addRoutee(Routee routee)

Create a new instance with one more routee and the same RoutingLogic.

addRoutee

public Router addRoutee(ActorRef ref)

Create a new instance with one more ActorRefRoutee for the specified pekko.actor.ActorRef and the same RoutingLogic.

addRoutee

public Router addRoutee(ActorSelection sel)

Create a new instance with one more ActorSelectionRoutee for the specified pekko.actor.ActorSelection and the same RoutingLogic.

removeRoutee

public Router removeRoutee(Routee routee)

Create a new instance without the specified routee.

removeRoutee

public Router removeRoutee(ActorRef ref)

Create a new instance without the ActorRefRoutee for the specified pekko.actor.ActorRef.

removeRoutee

public Router removeRoutee(ActorSelection sel)

Create a new instance without the ActorSelectionRoutee for the specified pekko.actor.ActorSelection.

copy

public Router copy(RoutingLogic logic,
                   scala.collection.immutable.IndexedSeq<Routee> routees)

copy$default$1

public RoutingLogic copy$default$1()

copy$default$2

public scala.collection.immutable.IndexedSeq<Routee> copy$default$2()

productPrefix

public java.lang.String productPrefix()

Specified by:

productPrefix in interface scala.Product

productArity

public int productArity()

Specified by:

productArity in interface scala.Product

productElement

public java.lang.Object productElement(int x$1)

Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<java.lang.Object> productIterator()

Specified by:

productIterator in interface scala.Product

canEqual

public boolean canEqual(java.lang.Object x$1)

Specified by:

canEqual in interface scala.Equals

productElementName

public java.lang.String productElementName(int x$1)

Specified by:

productElementName in interface scala.Product

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object x$1)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class java.lang.Object