co.paralleluniverse.actors.behaviors

Class Supervisor

java.lang.Object

co.paralleluniverse.actors.ActorRef<Message>

co.paralleluniverse.actors.ActorRefDelegate<Object>

co.paralleluniverse.actors.behaviors.Behavior

co.paralleluniverse.actors.behaviors.Supervisor

All Implemented Interfaces:

Port<Object>, SendPort<Object>, Serializable, AutoCloseable

public class Supervisor
extends Behavior

An interface to a SupervisorActor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Supervisor.ChildMode Determines whether a child (supervised) actor should be restarted if the supervisor's restart strategy states that it should be restarted.
static class	Supervisor.ChildSpec Describes a child actor's configuration in a supervisor

Constructor Summary

Constructors

Constructor and Description
Supervisor(ActorRef<Object> actor) If actor is known to be a ServerActor, creates a new Server interface to it.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ActorRef<M>,M> T	addChild(Supervisor.ChildSpec spec) Adds a new child actor to the supervisor.
<T extends ActorRef<M>,M> T	getChild(Object id) Retrieves a child actor by its id This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.
List<? extends ActorRef<?>>	getChildren() Retrieves the children actor references as an immutable list.
boolean	removeChild(ActorRef<?> actor, boolean terminate) Removes a child actor from the supervisor.
boolean	removeChild(Object id, boolean terminate) Removes a child actor from the supervisor.
String	toString()

Methods inherited from class co.paralleluniverse.actors.behaviors.Behavior

shutdown

Methods inherited from class co.paralleluniverse.actors.ActorRefDelegate

getImpl, isInActor

Methods inherited from class co.paralleluniverse.actors.ActorRef

close, close, equals, getName, hashCode, interrupt, send, send, send, sendSync, trySend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Supervisor

public Supervisor(ActorRef<Object> actor)

If actor is known to be a ServerActor, creates a new Server interface to it. Normally, you don't use this constructor, but the Supervisor instance returned by SupervisorActor.spawn().

Parameters:

actor - a ServerActor

Method Detail

addChild

public final <T extends ActorRef<M>,M> T addChild(Supervisor.ChildSpec spec)
                                  throws SuspendExecution,
                                         InterruptedException

Adds a new child actor to the supervisor. If the child has not been started, it will be started by the supervisor. This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.

Parameters:

spec - the child's spec.

Returns:

the actor (possibly after it has been started by the supervisor).

Throws:

InterruptedException

SuspendExecution

getChild

public final <T extends ActorRef<M>,M> T getChild(Object id)
                                  throws SuspendExecution,
                                         InterruptedException

Retrieves a child actor by its id This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.

Parameters:

id - the child's id in the supervisor.

Returns:

the child, if found; null if the child was not found

Throws:

SuspendExecution

InterruptedException

getChildren

public final List<? extends ActorRef<?>> getChildren()
                                              throws SuspendExecution,
                                                     InterruptedException

Retrieves the children actor references as an immutable list. This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.

Returns:

the children ActorRefs.

Throws:

SuspendExecution

InterruptedException

removeChild

public final boolean removeChild(Object id,
                  boolean terminate)
                          throws SuspendExecution,
                                 InterruptedException

Removes a child actor from the supervisor. This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.

Parameters:

id - the child's id in the supervisor.

terminate - whether or not the supervisor should terminate the actor

Returns:

true if the actor has been successfully removed from the supervisor; false if the child was not found.

Throws:

InterruptedException

SuspendExecution

removeChild

public boolean removeChild(ActorRef<?> actor,
                  boolean terminate)
                    throws SuspendExecution,
                           InterruptedException

Removes a child actor from the supervisor. This method does not block when called from within the Supervisor's context, so, in particular, it may be called by an actor constructor, constructed by the supervisor.

Parameters:

actor - the child actor

terminate - whether or not the supervisor should terminate the actor

Returns:

true if the actor has been successfully removed from the supervisor; false if the child was not found.

Throws:

InterruptedException

SuspendExecution

toString

public String toString()

Overrides:

toString in class ActorRef<Object>