com.emphysic.myriad.network

Class WorkerPool

java.lang.Object

akka.actor.UntypedActor

com.emphysic.myriad.network.WorkerPool

All Implemented Interfaces:

akka.actor.Actor

Direct Known Subclasses:

LinkedWorkerPool

public abstract class WorkerPool
extends akka.actor.UntypedActor

WorkerPool - a pool of identical worker processes

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULTWORKERS Default number of workers in a pool
protected akka.actor.ActorRef	router Manages the workers

Constructor Summary

Constructors

Constructor and Description
WorkerPool()

Method Summary

Modifier and Type	Method and Description
java.lang.String	genMessage(java.lang.String orig) Prepends this instance's ID to a String.
akka.actor.ActorRef	getRouter() Retrieves the worker manager Actor
void	setRouter(akka.actor.ActorRef router) Sets the worker manager
void	shutdown() Initiates shutdown
void	start(java.lang.Class<? extends akka.actor.UntypedActor> workerClass, java.lang.Object... args) Creates a new worker pool that tries to send to the non-suspended routee with fewest messages in mailbox.
void	start(int numWorkers, java.lang.Class<? extends akka.actor.UntypedActor> workerClass, java.lang.Object... args) Creates a new worker pool that tries to send to the non-suspended routee with fewest messages in mailbox.
void	start(akka.routing.Pool pool, java.lang.Class<? extends akka.actor.UntypedActor> workerClass, java.lang.Object... args) Creates a new pool of workers
void	tellRouter(java.lang.Object message) Sends an Akka message to the worker pool from this instance
void	tellRouter(java.lang.Object message, akka.actor.ActorRef sender) Sends an Akka message to the worker pool

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, getContext, getSelf, getSender, onReceive, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

router

protected akka.actor.ActorRef router

Manages the workers

DEFAULTWORKERS

protected static final int DEFAULTWORKERS

Default number of workers in a pool

See Also:

Constant Field Values

Constructor Detail

WorkerPool

public WorkerPool()

Method Detail

start

public void start(akka.routing.Pool pool,
                  java.lang.Class<? extends akka.actor.UntypedActor> workerClass,
                  java.lang.Object... args)

Creates a new pool of workers

Parameters:

pool - Router actor that creates workers

workerClass - the type of worker in the pool

args - constructor arguments for the worker class

start

public void start(int numWorkers,
                  java.lang.Class<? extends akka.actor.UntypedActor> workerClass,
                  java.lang.Object... args)

Creates a new worker pool that 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

Parameters:

numWorkers - number of workers in the pool

workerClass - class of worker

args - optional constructor arguments for the worker

start

public void start(java.lang.Class<? extends akka.actor.UntypedActor> workerClass,
                  java.lang.Object... args)

Creates a new worker pool that 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

Parameters:

workerClass - class of worker

args - optional constructor arguments for the worker

genMessage

public java.lang.String genMessage(java.lang.String orig)

Prepends this instance's ID to a String. Primarily used in logging.

Parameters:

orig - original message

Returns:

ID + ": " + original message

getRouter

public akka.actor.ActorRef getRouter()

Retrieves the worker manager Actor

Returns:

router

setRouter

public void setRouter(akka.actor.ActorRef router)

Sets the worker manager

Parameters:

router - new router

tellRouter

public void tellRouter(java.lang.Object message,
                       akka.actor.ActorRef sender)

Sends an Akka message to the worker pool

Parameters:

message - message to send

sender - message's sender

tellRouter

public void tellRouter(java.lang.Object message)

Sends an Akka message to the worker pool from this instance

Parameters:

message - message to send

shutdown

public void shutdown()

Initiates shutdown