Package org.apache.pekko.routing

Class SmallestMailboxRoutingLogic

java.lang.Object
org.apache.pekko.routing.SmallestMailboxRoutingLogic
All Implemented Interfaces:
NoSerializationVerificationNeeded, RoutingLogic
public class SmallestMailboxRoutingLogic extends Object implements RoutingLogic
Tries to send to the non-suspended routee with fewest messages in mailbox. The selection is done in this order:
  • pick any idle routee (not processing message) with empty mailbox
  • pick any routee with empty mailbox
  • pick routee with fewest pending messages in mailbox
  • pick any remote routee, remote actors are consider lowest priority, since their mailbox size is unknown

  • Constructor Details

    • SmallestMailboxRoutingLogic

      public SmallestMailboxRoutingLogic()

  • Method Details

    • apply

      public static SmallestMailboxRoutingLogic apply()

    • select

      public Routee select(Object message, scala.collection.immutable.IndexedSeq<Routee> routees)
      Description copied from interface: RoutingLogic
      Pick the destination for a given message. Normally it picks one of the passed routees, but in the end it is up to the implementation to return whatever pekko.routing.Routee to use for sending a specific message.

      When implemented from Java it can be good to know that routees.apply(index) can be used to get an element from the IndexedSeq.

      Specified by:
      select in interface RoutingLogic

    • isTerminated

      protected boolean isTerminated(Routee a)

    • isProcessingMessage

      protected boolean isProcessingMessage(Routee a)
      Returns true if the actor is currently processing a message. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    • hasMessages

      protected boolean hasMessages(Routee a)
      Returns true if the actor currently has any pending messages in the mailbox, i.e. the mailbox is not empty. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    • isSuspended

      protected boolean isSuspended(Routee a)
      Returns true if the actor is currently suspended. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    • numberOfMessages

      protected int numberOfMessages(Routee a)
      Returns the number of pending messages in the mailbox of the actor. It will always return 0 for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.