C# Class Akka.Routing.BroadcastPool

This class represents a Pool router that sends messages it receives to all of its routees.
Inheritance: Akka.Routing.Pool
Datei anzeigen Open project: rogeralsing/akka.net

Public Methods

Method Description
BroadcastPool ( Config config ) : System.Collections.Generic

Initializes a new instance of the BroadcastPool class.

BroadcastPool ( int nrOfInstances ) : System.Collections.Generic

Initializes a new instance of the BroadcastPool class. A BroadcastPool configured in this way uses the Pool.DefaultStrategy supervisor strategy.

BroadcastPool ( int nrOfInstances, Akka.Routing.Resizer resizer, Akka.Actor.SupervisorStrategy supervisorStrategy, string routerDispatcher, bool usePoolDispatcher = false ) : System.Collections.Generic

Initializes a new instance of the BroadcastPool class.

CreateRouter ( ActorSystem system ) : Router

Creates a router that is responsible for routing messages to routees within the provided system.

ToSurrogate ( ActorSystem system ) : ISurrogate

Creates a surrogate representation of the current BroadcastPool.

WithDispatcher ( string dispatcher ) : Akka.Routing.Pool

Creates a new BroadcastPool router with a given dispatcher id. This method is immutable and returns a new instance of the router.

WithFallback ( Akka.Routing.RouterConfig routerConfig ) : Akka.Routing.RouterConfig

Configure the current router with an auxiliary router for routes that it does not know how to handle.

WithResizer ( Akka.Routing.Resizer resizer ) : Akka.Routing.Pool

Creates a new BroadcastPool router with a given Resizer. This method is immutable and returns a new instance of the router.

WithSupervisorStrategy ( Akka.Actor.SupervisorStrategy strategy ) : Akka.Routing.Pool

Creates a new BroadcastPool router with a given SupervisorStrategy. This method is immutable and returns a new instance of the router.

Method Details

BroadcastPool() public method

Initializes a new instance of the BroadcastPool class.
public BroadcastPool ( Config config ) : System.Collections.Generic
config Akka.Configuration.Config The configuration used to configure the pool.
return System.Collections.Generic

BroadcastPool() public method

Initializes a new instance of the BroadcastPool class. A BroadcastPool configured in this way uses the Pool.DefaultStrategy supervisor strategy.
public BroadcastPool ( int nrOfInstances ) : System.Collections.Generic
nrOfInstances int The initial number of routees in the pool.
return System.Collections.Generic

BroadcastPool() public method

Initializes a new instance of the BroadcastPool class.
public BroadcastPool ( int nrOfInstances, Akka.Routing.Resizer resizer, Akka.Actor.SupervisorStrategy supervisorStrategy, string routerDispatcher, bool usePoolDispatcher = false ) : System.Collections.Generic
nrOfInstances int The initial number of routees in the pool.
resizer Akka.Routing.Resizer The resizer to use when dynamically allocating routees to the pool.
supervisorStrategy Akka.Actor.SupervisorStrategy The strategy to use when supervising the pool.
routerDispatcher string The dispatcher to use when passing messages to the routees.
usePoolDispatcher bool true to use the pool dispatcher; otherwise false.
return System.Collections.Generic

CreateRouter() public method

Creates a router that is responsible for routing messages to routees within the provided system.
public CreateRouter ( ActorSystem system ) : Router
system ActorSystem The actor system that owns this router.
return Router

ToSurrogate() public method

Creates a surrogate representation of the current BroadcastPool.
public ToSurrogate ( ActorSystem system ) : ISurrogate
system ActorSystem The actor system that owns this router.
return ISurrogate

WithDispatcher() public method

Creates a new BroadcastPool router with a given dispatcher id. This method is immutable and returns a new instance of the router.
public WithDispatcher ( string dispatcher ) : Akka.Routing.Pool
dispatcher string The dispatcher id used to configure the new router.
return Akka.Routing.Pool

WithFallback() public method

Configure the current router with an auxiliary router for routes that it does not know how to handle.
public WithFallback ( Akka.Routing.RouterConfig routerConfig ) : Akka.Routing.RouterConfig
routerConfig Akka.Routing.RouterConfig The router to use as an auxiliary source.
return Akka.Routing.RouterConfig

WithResizer() public method

Creates a new BroadcastPool router with a given Resizer. This method is immutable and returns a new instance of the router.
public WithResizer ( Akka.Routing.Resizer resizer ) : Akka.Routing.Pool
resizer Akka.Routing.Resizer The used to configure the new router.
return Akka.Routing.Pool

WithSupervisorStrategy() public method

Creates a new BroadcastPool router with a given SupervisorStrategy. This method is immutable and returns a new instance of the router.
public WithSupervisorStrategy ( Akka.Actor.SupervisorStrategy strategy ) : Akka.Routing.Pool
strategy Akka.Actor.SupervisorStrategy The used to configure the new router.
return Akka.Routing.Pool