|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface 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). The resulting RoutedActorRef optimizes the sending of the message so that it does NOT go through the router’s mailbox unless the route returns an empty recipient set.
'''Caution:''' This means that the route function is evaluated concurrently without protection by the RoutedActorRef: either provide a reentrant (i.e. pure) implementation or do the locking yourself!
'''Caution:''' Please note that the Router
which needs to
be returned by createActor()
should not send a message to itself in its
constructor or preStart()
or publish its self reference from there: if
someone tries sending a message to that reference before the constructor of
RoutedActorRef has returned, there will be a NullPointerException
!
Method Summary | |
---|---|
Router |
createActor()
The router "head" actor. |
scala.PartialFunction<scala.Tuple2<ActorRef,java.lang.Object>,scala.collection.Iterable<Destination>> |
createRoute(RouteeProvider routeeProvider)
Implement the routing logic by returning a partial function of partial function from (sender, message) to a set of destinations. |
RouteeProvider |
createRouteeProvider(ActorContext context,
Props routeeProps)
The RouteeProvider responsible for creating or
looking up routees. |
scala.Option<Resizer> |
resizer()
Routers with dynamically resizable number of routees return the Resizer
to use. |
java.lang.String |
routerDispatcher()
Dispatcher ID to use for running the “head” actor, i.e. the Router . |
SupervisorStrategy |
supervisorStrategy()
SupervisorStrategy for the created Router actor. |
scala.collection.Iterable<Destination> |
toAll(ActorRef sender,
scala.collection.Iterable<ActorRef> routees)
|
void |
verifyConfig()
Check that everything is there which is needed. |
RouterConfig |
withFallback(RouterConfig other)
Overridable merge strategy, by default completely prefers “this” (i.e. no merge). |
Method Detail |
---|
scala.PartialFunction<scala.Tuple2<ActorRef,java.lang.Object>,scala.collection.Iterable<Destination>> createRoute(RouteeProvider routeeProvider)
Route
will be applied for each incoming message.
When createRoute
is called the routees should also be registered,
typically by using createRoutees
or registerRouteesFor
of the
supplied RouteeProvider
.
RouteeProvider createRouteeProvider(ActorContext context, Props routeeProps)
RouteeProvider
responsible for creating or
looking up routees. It's used in createRoute
to register routees,
and also from Resizer
.
Router createActor()
SupervisorStrategy supervisorStrategy()
java.lang.String routerDispatcher()
Router
.
RouterConfig withFallback(RouterConfig other)
scala.collection.Iterable<Destination> toAll(ActorRef sender, scala.collection.Iterable<ActorRef> routees)
scala.Option<Resizer> resizer()
Resizer
to use.
void verifyConfig()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |