Package org.apache.pekko.routing

Interface Summary

Interface	Description
ConsistentHashingRouter.ConsistentHashable	If you don't define the hashMapping when constructing the pekko.routing.ConsistentHashingRouter the messages need to implement this interface to define what data to use for the consistent hash key.
ConsistentHashingRouter.ConsistentHashMapper	JAVA API Mapping from message to the data to use for the consistent hash key.
Group	RouterConfig for router actor with routee actors that are created external to the router and the router sends messages to the specified path using actor selection, without watching for termination.
ListenerMessage
Listeners	Listeners is a generic trait to implement listening capability on an Actor.
OptimalSizeExploringResizer
Pool	RouterConfig for router actor that creates routees as child actors and removes them from the router if they terminate.
PoolOverrideUnsetConfig<T extends Pool>	INTERNAL API
Resizer	Pool routers with dynamically resizable number of routees are implemented by providing a Resizer implementation in the pekko.routing.Pool configuration.
Routee	Abstraction of a destination for messages routed via a Router.
RouterConfig	This trait represents a router factory: it produces the actual router actor and creates the routing table (a function which determines the recipients for each message which is to be dispatched).
RouterEnvelope	Only the contained message will be forwarded to the destination, i.e.
RouterManagementMesssage	INTERNAL API
RoutingLogic	The interface of the routing logic that is used in a Router to select destination routed messages.

Class Summary

Class	Description
ActorRefRoutee	Routee that sends the messages to an pekko.actor.ActorRef.
ActorRefRoutee$
ActorSelectionRoutee	Routee that sends the messages to an pekko.actor.ActorSelection.
ActorSelectionRoutee$
AddRoutee	Add a routee by sending this message to the router.
AddRoutee$
AdjustPoolSize	Increase or decrease the number of routees in a Pool.
AdjustPoolSize$
BalancingPool	A router pool that will try to redistribute work from busy routees to idle routees.
BalancingPool$
BalancingPoolDeploy	INTERNAL API Can't be in the BalancingPool companion for binary compatibility reasons.
BalancingPoolDeploy$	INTERNAL API Can't be in the BalancingPool companion for binary compatibility reasons.
BalancingRoutingLogic$	INTERNAL API
Broadcast	Used to broadcast a message to all routees in a router; only the contained message will be forwarded, i.e.
Broadcast$
BroadcastGroup	A router group that broadcasts a message to all its routees.
BroadcastGroup$
BroadcastPool	A router pool that broadcasts a message to all its routees.
BroadcastPool$
BroadcastRoutingLogic	Broadcasts a message to all its routees.
BroadcastRoutingLogic$
ConsistentHash<T>	Consistent Hashing node ring implementation.
ConsistentHash$
ConsistentHashingGroup	A router group that uses consistent hashing to select a routee based on the sent message.
ConsistentHashingGroup$
ConsistentHashingPool	A router pool that uses consistent hashing to select a routee based on the sent message.
ConsistentHashingPool$
ConsistentHashingRouter
ConsistentHashingRouter.ConsistentHashableEnvelope	If you don't define the hashMapping when constructing the pekko.routing.ConsistentHashingRouter and messages can't implement pekko.routing.ConsistentHashingRouter.ConsistentHashable themselves they can we wrapped by this envelope instead.
ConsistentHashingRouter.ConsistentHashableEnvelope$
ConsistentHashingRouter.emptyConsistentHashMapping$
ConsistentHashingRouter$
ConsistentHashingRoutingLogic
ConsistentHashingRoutingLogic$
ConsistentRoutee$
CustomRouterConfig	If a custom router implementation is not a Group nor a Pool it may extend this base class.
Deafen
Deafen$
DefaultOptimalSizeExploringResizer	This resizer resizes the pool to an optimal size that provides the most message throughput.
DefaultOptimalSizeExploringResizer$
DefaultResizer
DefaultResizer$
FromConfig	Java API: Wraps a pekko.actor.Props to mark the actor as externally configurable to be used with a router.
FromConfig$	Wraps a pekko.actor.Props to mark the actor as externally configurable to be used with a router.
GetRoutees	Sending this message to a router will make it send back its currently used routees.
GetRoutees$
GroupBase	Java API: Base class for custom router Group
Listen
Listen$
MurmurHash	An object designed to generate well-distributed non-cryptographic hashes.
MurmurHash$	An object designed to generate well-distributed non-cryptographic hashes.
NoRoutee	Routee that doesn't send the message to any routee.
NoRoutee$	Routee that doesn't send the message to any routee.
NoRouter	Routing configuration that indicates no routing; this is also the default value which hence overrides the merge strategy in order to accept values from lower-precedence sources.
NoRouter$
OptimalSizeExploringResizer.ResizeRecord	INTERNAL API
OptimalSizeExploringResizer.ResizeRecord$
OptimalSizeExploringResizer.UnderUtilizationStreak	INTERNAL API
OptimalSizeExploringResizer.UnderUtilizationStreak$
OptimalSizeExploringResizer$
Pool$
PoolBase	Java API: Base class for custom router Pool
RandomGroup	A router group that randomly selects one of the target routees to send a message to.
RandomGroup$
RandomPool	A router pool that randomly selects one of the target routees to send a message to.
RandomPool$
RandomRoutingLogic	Randomly selects one of the target routees to send a message to
RandomRoutingLogic$
RemoveRoutee	Remove a specific routee by sending this message to the router.
RemoveRoutee$
ResizablePoolActor$	INTERNAL API
Resizer$
RoundRobinGroup	A router group that uses round-robin to select a routee.
RoundRobinGroup$
RoundRobinPool	A router pool that uses round-robin to select a routee.
RoundRobinPool$
RoundRobinRoutingLogic	Uses round-robin to select a routee.
RoundRobinRoutingLogic$
RoutedActorCell$	INTERNAL API
Routees	Message used to carry information about what routees the router is currently using.
Routees$
Router	For each message that is sent through the router via the Router.route(java.lang.Object, org.apache.pekko.actor.ActorRef) method the RoutingLogic decides to which Routee to send the message.
Router$
ScatterGatherFirstCompletedGroup	A router group that broadcasts the message to all routees, and replies with the first response.
ScatterGatherFirstCompletedGroup$
ScatterGatherFirstCompletedPool	A router pool that broadcasts the message to all routees, and replies with the first response.
ScatterGatherFirstCompletedPool$
ScatterGatherFirstCompletedRoutees$
ScatterGatherFirstCompletedRoutingLogic	Broadcasts the message to all routees, and replies with the first response.
ScatterGatherFirstCompletedRoutingLogic$
SeveralRoutees	Routee that sends each message to all routees.
SeveralRoutees$
SmallestMailboxPool	A router pool that tries to send to the non-suspended routee with fewest messages in mailbox.
SmallestMailboxPool$
SmallestMailboxRoutingLogic	Tries to send to the non-suspended routee with fewest messages in mailbox.
SmallestMailboxRoutingLogic$
TailChoppingGroup	A router group with retry logic, intended for cases where a return message is expected in response to a message sent to the routee.
TailChoppingGroup$
TailChoppingPool	A router pool with retry logic, intended for cases where a return message is expected in response to a message sent to the routee.
TailChoppingPool$
TailChoppingRoutees$
TailChoppingRoutingLogic	As each message is sent to the router, the routees are randomly ordered.
TailChoppingRoutingLogic$
WithListeners
WithListeners$

Exception Summary

Exception	Description
ResizerInitializationException