io.vlingo.xoom.actors

Class Stage

java.lang.Object

io.vlingo.xoom.actors.Stage

All Implemented Interfaces:

Stoppable

public class Stage
extends Object
implements Stoppable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Stage.ActorProtocolActor<T> Internal type used to manage Actor proxy creation.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.vlingo.xoom.actors.Directory	directory
protected World	world

Constructor Summary

Constructors

Constructor and Description
Stage(World world, AddressFactory addressFactory, String name) Initializes the new Stage of theworld, addressFactory, and with name.
Stage(World world, AddressFactory addressFactory, String name, int directoryBuckets, int directoryInitialCapacity) Initializes the new Stage of theworld, addressFactory, name, and Directory capacity of directoryBuckets and directoryInitialCapacity.

Method Summary

Modifier and Type	Method and Description
<T> T	actorAs(Actor actor, Class<T> protocol) Answers the T protocol type as the means to message the backing Actor.
Protocols	actorFor(Class<?>[] protocols, Class<? extends Actor> type, Object... parameters) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.
Protocols	actorFor(Class<?>[] protocols, Definition definition) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.
Protocols	actorFor(Class<?>[] protocols, Definition definition, Actor parent, Supervisor maybeSupervisor, Logger logger) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.
<T,A extends Actor> T	actorFor(Class<T> protocol, Class<? extends Actor> type, ActorInstantiator<A> instantiator) Answers the T protocol of the newly created Actor that implements the protocol.
<T> T	actorFor(Class<T> protocol, Class<? extends Actor> type, Object... parameters) Answers the T protocol of the newly created Actor that implements the protocol.
<T> T	actorFor(Class<T> protocol, Definition definition) Answers the T protocol of the newly created Actor that implements the protocol.
protected <T> T	actorFor(Class<T> protocol, Definition definition, Actor parent, Supervisor maybeSupervisor, Logger logger) Answers the T protocol for the newly created Actor instance.
<T> T	actorFor(Class<T> protocol, Definition definition, Address address) Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific address.
<T> T	actorFor(Class<T> protocol, Definition definition, Address address, Logger logger) Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific address and logger.
<T> T	actorFor(Class<T> protocol, Definition definition, Logger logger) Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific logger.
<T> io.vlingo.xoom.common.Completes<T>	actorOf(Class<T> protocol, Address address) Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or null if not found.
<T,A extends Actor> io.vlingo.xoom.common.Completes<T>	actorOf(Class<T> protocol, Address address, Class<? extends Actor> type, ActorInstantiator<A> instantiator) Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or the {#code T} instance of the new Actor created for type by the instantiator.
<T> io.vlingo.xoom.common.Completes<T>	actorOf(Class<T> protocol, Address address, Class<? extends Actor> type, Object... parameters) Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or the T instance of the new Actor created for type with the parameters.
<T> io.vlingo.xoom.common.Completes<T>	actorOf(Class<T> protocol, Address address, Definition definition) Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or a new Actor instance of the type and definition.
protected Stage.ActorProtocolActor<Object>[]	actorProtocolFor(Class<?>[] protocols, Definition definition, Actor parent, Address maybeAddress, Mailbox maybeMailbox, Supervisor maybeSupervisor, Logger logger) Answers the ActorProtocolActor[] for the newly created Actor instance.
protected Stage.ActorProtocolActor<Object>[]	actorProtocolFor(Class<?>[] protocols, Definition definition, Actor parent, Supervisor maybeSupervisor, Logger logger) Answers the ActorProtocolActor[] for the newly created Actor instance.
protected <T> Stage.ActorProtocolActor<T>	actorProtocolFor(Class<T> protocol, Definition definition, Actor parent, Address maybeAddress, Mailbox maybeMailbox, Supervisor maybeSupervisor, Logger logger) Answers the ActorProtocolActor for the newly created Actor instance.
protected <T> T	actorThunkFor(Class<T> protocol, Definition definition, Address address)
AddressFactory	addressFactory() Answer my addressFactory.
protected Address	allocateAddress(Definition definition, Address maybeAddress) Answers an Address for an Actor.
protected Mailbox	allocateMailbox(Definition definition, Address address, Mailbox maybeMailbox) Answers a Mailbox for an Actor.
void	conclude() Concludes the receiver, eventually causing it to receive a stop() message.
int	count() Answers the int count of the number of Actor instances contained in this Stage.
protected io.vlingo.xoom.actors.Directory	directory() Answers my Directory instance.
void	dump() A debugging tool used to print information about the Actor instances contained in this Stage.
protected void	extenderStartDirectoryScanner()
boolean	isStopped() Answers whether or not this Stage has been stopped or is in the process of stopping.
protected ActorFactory.MailboxWrapper	mailboxWrapper()
<T> io.vlingo.xoom.common.Completes<Optional<T>>	maybeActorOf(Class<T> protocol, Address address) Answer the protocol reference of the actor with address as a non-empty Completes<Optional<T>> eventual outcome, or an empty Completes<Optional<T>> if not found.
String	name() Answers the name of this Stage.
void	registerCommonSupervisor(Class<?> protocol, Supervisor common) Registers with this Stage the common supervisor for the given protocol.
io.vlingo.xoom.common.Scheduler	scheduler() Answers the Scheduler of this Stage.
void	stop() Initiates the process of stopping this Stage.
Protocols	testActorFor(Class<?>[] protocols, Definition definition) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition, that can be used for testing.
<T> TestActor<T>	testActorFor(Class<T> protocol, Class<? extends Actor> type, Object... parameters)
<T> TestActor<T>	testActorFor(Class<T> protocol, Definition definition) Answers the TestActor<T>, T being the protocol, of the new created Actor that implements the protocol.
World	world() Answers the World instance of this Stage.

Methods inherited from class java.lang.Object

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

Field Detail

directory

protected final io.vlingo.xoom.actors.Directory directory

world

protected final World world

Constructor Detail

Stage

public Stage(World world,
             AddressFactory addressFactory,
             String name)

Initializes the new Stage of theworld, addressFactory, and with name. Uses default Directory capacity of 32x32.

Parameters:

world - the World parent of this Stage

addressFactory - the AddressFactory to be used

name - the String name of this Stage

Stage

public Stage(World world,
             AddressFactory addressFactory,
             String name,
             int directoryBuckets,
             int directoryInitialCapacity)

Initializes the new Stage of theworld, addressFactory, name, and Directory capacity of directoryBuckets and directoryInitialCapacity.

Parameters:

world - the World parent of this Stage

addressFactory - the AddressFactory to be used

name - the String name of this Stage

directoryBuckets - the int number of buckets

directoryInitialCapacity - the int initial number of elements in each bucket

Method Detail

actorAs

public <T> T actorAs(Actor actor,
                     Class<T> protocol)

Answers the T protocol type as the means to message the backing Actor.

Type Parameters:

T - the protocol type

Parameters:

actor - the Actor that implements the Class<T> protocol

protocol - the Class<T> protocol

Returns:

T

actorFor

public <T,A extends Actor> T actorFor(Class<T> protocol,
                                      Class<? extends Actor> type,
                                      ActorInstantiator<A> instantiator)

Answers the T protocol of the newly created Actor that implements the protocol.

Type Parameters:

T - the protocol type

A - the Actor type

Parameters:

protocol - the Class<T> protocol

type - the Class<? extends Actor> of the Actor to create

instantiator - the ActorInstantiator<A> used to instantiate the Actor

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Class<? extends Actor> type,
                      Object... parameters)

Answers the T protocol of the newly created Actor that implements the protocol.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

type - the Class<? extends Actor> of the Actor to create

parameters - the Object[] of constructor parameters

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Definition definition)

Answers the T protocol of the newly created Actor that implements the protocol.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

definition - the Definition used to initialize the newly created Actor

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Definition definition,
                      Address address)

Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific address.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

definition - the Definition used to initialize the newly created Actor

address - the Address to assign to the newly created Actor

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Definition definition,
                      Logger logger)

Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific logger.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

definition - the Definition used to initialize the newly created Actor

logger - the Logger to assign to the newly created Actor

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Definition definition,
                      Address address,
                      Logger logger)

Answers the T protocol of the newly created Actor that implements the protocol and that will be assigned the specific address and logger.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

definition - the Definition used to initialize the newly created Actor

address - the Address to assign to the newly created Actor

logger - the Logger to assign to the newly created Actor

Returns:

T

actorFor

public Protocols actorFor(Class<?>[] protocols,
                          Definition definition)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.

Parameters:

protocols - the Class<?>[] array of protocols that the Actor supports

definition - the Definition providing parameters to the Actor

Returns:

Protocols

actorFor

public Protocols actorFor(Class<?>[] protocols,
                          Definition definition,
                          Actor parent,
                          Supervisor maybeSupervisor,
                          Logger logger)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.

Parameters:

protocols - the Class<?>[] array of protocols that the Actor supports

definition - the Definition providing parameters to the Actor

parent - the Actor that is this actor's parent

maybeSupervisor - the possible Supervisor of this actor

logger - the Logger of this actor

Returns:

Protocols

actorFor

public Protocols actorFor(Class<?>[] protocols,
                          Class<? extends Actor> type,
                          Object... parameters)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.

Parameters:

protocols - the Class<?>[] array of protocols that the Actor supports

type - the Class<? extends Actor> of the Actor to create

parameters - the Object[] of constructor parameters

Returns:

Protocols

actorOf

public <T> io.vlingo.xoom.common.Completes<T> actorOf(Class<T> protocol,
                                                      Address address)

Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or null if not found.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol supported by the backing Actor

address - the Address of the Actor to find

Returns:

Completes<T>

actorOf

public <T,A extends Actor> io.vlingo.xoom.common.Completes<T> actorOf(Class<T> protocol,
                                                                      Address address,
                                                                      Class<? extends Actor> type,
                                                                      ActorInstantiator<A> instantiator)

Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or the {#code T} instance of the new Actor created for type by the instantiator.

Type Parameters:

T - the protocol type

A - the Actor type

Parameters:

protocol - the Class<T> protocol

address - the Address of the Actor to find or to create the new Actor with if not found

type - the Class<? extends Actor> of the Actor to create

instantiator - the ActorInstantiator<A> used to instantiate the Actor

Returns:

T

actorOf

public <T> io.vlingo.xoom.common.Completes<T> actorOf(Class<T> protocol,
                                                      Address address,
                                                      Class<? extends Actor> type,
                                                      Object... parameters)

Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or the T instance of the new Actor created for type with the parameters.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol supported by the backing Actor

address - the Address of the Actor to find or to create the new Actor with if not found

type - the Class<? extends Actor> of the Actor to create

parameters - the Object[] of constructor parameters

Returns:

Completes<T>

actorOf

public <T> io.vlingo.xoom.common.Completes<T> actorOf(Class<T> protocol,
                                                      Address address,
                                                      Definition definition)

Answers the Completes<T> that will eventually complete with the T protocol of the backing Actor of the given address, or a new Actor instance of the type and definition.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol supported by the backing Actor

address - the Address of the Actor to find and to create the new Actor with if not found

definition - the Definition providing parameters to the Actor

Returns:

Completes<T>

addressFactory

public AddressFactory addressFactory()

Answer my addressFactory.

Returns:

AddressFactory

maybeActorOf

public <T> io.vlingo.xoom.common.Completes<Optional<T>> maybeActorOf(Class<T> protocol,
                                                                     Address address)

Answer the protocol reference of the actor with address as a non-empty Completes<Optional<T>> eventual outcome, or an empty Completes<Optional<T>> if not found.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> of the protocol that the actor must support

address - the Address of the actor to find

Returns:

Completes<Optional<T>>

testActorFor

public final <T> TestActor<T> testActorFor(Class<T> protocol,
                                           Class<? extends Actor> type,
                                           Object... parameters)

testActorFor

public final <T> TestActor<T> testActorFor(Class<T> protocol,
                                           Definition definition)

Answers the TestActor<T>, T being the protocol, of the new created Actor that implements the protocol. The TestActor<T> is specifically used for test scenarios and provides runtime access to the internal Actor instance. Test-based Actor instances are backed by the synchronous TestMailbox.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

definition - the Definition used to initialize the newly created Actor

Returns:

T

testActorFor

public final Protocols testActorFor(Class<?>[] protocols,
                                    Definition definition)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition, that can be used for testing. Test-based Actor instances are backed by the synchronous TestMailbox.

Parameters:

protocols - the Class<T>[] array of protocols that the Actor supports

definition - the Definition providing parameters to the Actor

Returns:

Protocols

count

public int count()

Answers the int count of the number of Actor instances contained in this Stage.

Returns:

int

dump

public void dump()

A debugging tool used to print information about the Actor instances contained in this Stage.

name

public String name()

Answers the name of this Stage.

Returns:

String

registerCommonSupervisor

public void registerCommonSupervisor(Class<?> protocol,
                                     Supervisor common)

Registers with this Stage the common supervisor for the given protocol.

Parameters:

protocol - the Class<T> protocol to be supervised by common

common - the Supervisor to serve as the supervisor of all Actors implementing protocol

scheduler

public io.vlingo.xoom.common.Scheduler scheduler()

Answers the Scheduler of this Stage.

Returns:

Scheduler

isStopped

public boolean isStopped()

Answers whether or not this Stage has been stopped or is in the process of stopping.

Specified by:

isStopped in interface Stoppable

Returns:

boolean

conclude

public void conclude()

Description copied from interface: Stoppable

Concludes the receiver, eventually causing it to receive a stop() message.

Specified by:

conclude in interface Stoppable

See Also:

Stoppable.conclude()

stop

public void stop()

Initiates the process of stopping this Stage.

Specified by:

stop in interface Stoppable

world

public World world()

Answers the World instance of this Stage.

Returns:

World

actorFor

protected <T> T actorFor(Class<T> protocol,
                         Definition definition,
                         Actor parent,
                         Supervisor maybeSupervisor,
                         Logger logger)

Answers the T protocol for the newly created Actor instance. (INTERNAL ONLY)

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol of the Actor

definition - the Definition of the Actor

parent - the Actor parent of this Actor

maybeSupervisor - the possible Supervisor of this Actor

logger - the Logger of this Actor

Returns:

T

actorProtocolFor

protected Stage.ActorProtocolActor<Object>[] actorProtocolFor(Class<?>[] protocols,
                                                              Definition definition,
                                                              Actor parent,
                                                              Supervisor maybeSupervisor,
                                                              Logger logger)

Answers the ActorProtocolActor[] for the newly created Actor instance. (INTERNAL ONLY)

Parameters:

protocols - the Class<?>[] protocols of the Actor

definition - the Definition of the Actor

parent - the Actor parent of this Actor

maybeSupervisor - the possible Supervisor of this Actor

logger - the Logger of this Actor

Returns:

ActorProtocolActor[]

actorProtocolFor

protected <T> Stage.ActorProtocolActor<T> actorProtocolFor(Class<T> protocol,
                                                           Definition definition,
                                                           Actor parent,
                                                           Address maybeAddress,
                                                           Mailbox maybeMailbox,
                                                           Supervisor maybeSupervisor,
                                                           Logger logger)

Answers the ActorProtocolActor for the newly created Actor instance. (INTERNAL ONLY)

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol of the Actor

definition - the Definition of the Actor

parent - the Actor parent of this Actor

maybeAddress - the possible Address of this Actor

maybeMailbox - the possible Mailbox of this Actor

maybeSupervisor - the possible Supervisor of this Actor

logger - the Logger of this Actor

Returns:

ActorProtocolActor

actorProtocolFor

protected Stage.ActorProtocolActor<Object>[] actorProtocolFor(Class<?>[] protocols,
                                                              Definition definition,
                                                              Actor parent,
                                                              Address maybeAddress,
                                                              Mailbox maybeMailbox,
                                                              Supervisor maybeSupervisor,
                                                              Logger logger)

Answers the ActorProtocolActor[] for the newly created Actor instance. (INTERNAL ONLY)

Parameters:

protocols - the Class<?>[] protocols of the Actor

definition - the Definition of the Actor

parent - the Actor parent of this Actor

maybeAddress - the possible Address of this Actor

maybeMailbox - the possible Mailbox of this Actor

maybeSupervisor - the possible Supervisor of this Actor

logger - the Logger of this Actor

Returns:

ActorProtocolActor[]

actorThunkFor

protected <T> T actorThunkFor(Class<T> protocol,
                              Definition definition,
                              Address address)

extenderStartDirectoryScanner

protected void extenderStartDirectoryScanner()

allocateAddress

protected Address allocateAddress(Definition definition,
                                  Address maybeAddress)

Answers an Address for an Actor. If maybeAddress is allocated answer it; otherwise answer a newly allocated Address. (INTERNAL ONLY)

Parameters:

definition - the Definition of the newly created Actor

maybeAddress - the possible Address

Returns:

Address

allocateMailbox

protected Mailbox allocateMailbox(Definition definition,
                                  Address address,
                                  Mailbox maybeMailbox)

Answers a Mailbox for an Actor. If maybeMailbox is allocated answer it; otherwise answer a newly allocated Mailbox. (INTERNAL ONLY)

Parameters:

definition - the Definition of the newly created Actor

address - the Address allocated to the Actor

maybeMailbox - the possible Mailbox

Returns:

Mailbox

directory

protected io.vlingo.xoom.actors.Directory directory()

Answers my Directory instance.

Returns:

Directory

mailboxWrapper

protected ActorFactory.MailboxWrapper mailboxWrapper()