Package akka.routing

Class ScatterGatherFirstCompletedGroup

  • All Implemented Interfaces:
    Group, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

    public final class ScatterGatherFirstCompletedGroup
    extends java.lang.Object
    implements Group, scala.Product, java.io.Serializable
    A router group that broadcasts the message to all routees, and replies with the first response.

    The configuration parameter trumps the constructor arguments. This means that if you provide paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

    param: paths string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

    param: within expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure

    param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

    See Also:
    Serialized Form
    • Constructor Detail

      • ScatterGatherFirstCompletedGroup

        public ScatterGatherFirstCompletedGroup​(scala.collection.immutable.Iterable<java.lang.String> paths,
                                                scala.concurrent.duration.FiniteDuration within,
                                                java.lang.String routerDispatcher)
      • ScatterGatherFirstCompletedGroup

        public ScatterGatherFirstCompletedGroup​(com.typesafe.config.Config config)
      • ScatterGatherFirstCompletedGroup

        public ScatterGatherFirstCompletedGroup​(java.lang.Iterable<java.lang.String> routeePaths,
                                                scala.concurrent.duration.FiniteDuration within)
        Java API
        Parameters:
        routeePaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths
        within - expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure
      • ScatterGatherFirstCompletedGroup

        public ScatterGatherFirstCompletedGroup​(java.lang.Iterable<java.lang.String> routeePaths,
                                                java.time.Duration within)
        Java API
        Parameters:
        routeePaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths
        within - expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure
    • Method Detail

      • $lessinit$greater$default$3

        public static java.lang.String $lessinit$greater$default$3()
      • apply

        public static ScatterGatherFirstCompletedGroup apply​(scala.collection.immutable.Iterable<java.lang.String> paths,
                                                             scala.concurrent.duration.FiniteDuration within,
                                                             java.lang.String routerDispatcher)
      • apply$default$3

        public static java.lang.String apply$default$3()
      • unapply

        public static scala.Option<scala.Tuple3<scala.collection.immutable.Iterable<java.lang.String>,​scala.concurrent.duration.FiniteDuration,​java.lang.String>> unapply​(ScatterGatherFirstCompletedGroup x$0)
      • paths

        public scala.collection.immutable.Iterable<java.lang.String> paths()
      • within

        public scala.concurrent.duration.FiniteDuration within()
      • routerDispatcher

        public java.lang.String routerDispatcher()
        Description copied from interface: RouterConfig
        Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
        Specified by:
        routerDispatcher in interface RouterConfig
      • paths

        public scala.collection.immutable.Iterable<java.lang.String> paths​(ActorSystem system)
        Specified by:
        paths in interface Group
      • createRouter

        public Router createRouter​(ActorSystem system)
        Description copied from interface: RouterConfig
        Create the actual router, responsible for routing messages to routees.

        Specified by:
        createRouter in interface RouterConfig
        Parameters:
        system - the ActorSystem this router belongs to
      • withDispatcher

        public ScatterGatherFirstCompletedGroup withDispatcher​(java.lang.String dispatcherId)
        Setting the dispatcher to be used for the router head actor, which handles router management messages
      • copy

        public ScatterGatherFirstCompletedGroup copy​(scala.collection.immutable.Iterable<java.lang.String> paths,
                                                     scala.concurrent.duration.FiniteDuration within,
                                                     java.lang.String routerDispatcher)
      • copy$default$1

        public scala.collection.immutable.Iterable<java.lang.String> copy$default$1()
      • copy$default$2

        public scala.concurrent.duration.FiniteDuration copy$default$2()
      • copy$default$3

        public java.lang.String copy$default$3()
      • 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)
      • 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