Actor (org.codehaus.gpars)

groovyx.gpars.actor.Actor

Actors are active objects, which borrow a thread from a thread pool. The Actor interface provides means to send messages to the actor, start and stop the background thread as well as check its status.
Authors:
Vaclav Pech, Alex Tkachman

Field Summary

Fields
Modifiers	Name	Description
`protected static java.lang.String`	`ACTOR_HAS_ALREADY_BEEN_STARTED`
`private static java.lang.String`	`AFTER_START`
`static java.lang.String`	`CANNOT_SEND_REPLIES_NO_SENDER_HAS_BEEN_REGISTERED`
`private static java.lang.Object[]`	`EMPTY_ARGUMENTS`
`private static java.lang.String`	`ON_DELIVERY_ERROR`
`private static java.lang.String`	`RESPONDS_TO`
`protected static ActorMessage`	`START_MESSAGE`
`protected static ActorMessage`	`STOP_MESSAGE`
`protected static ActorMessage`	`TERMINATE_MESSAGE`
`static java.lang.String`	`TIMEOUT`
`protected static ActorMessage`	`TIMEOUT_MESSAGE`
`private static java.lang.ThreadLocal<Actor>`	`currentActorPerThread`	Maps each thread to the actor it currently processes.
`protected java.lang.Thread`	`currentThread`
`private DataflowExpression<java.lang.Object>`	`joinLatch`
`private groovy.lang.Closure`	`onStop`
`protected PGroup`	`parallelGroup`	The parallel group to which the message stream belongs
`private static long`	`serialVersionUID`
`protected static GeneralTimer`	`timer`	Timer holding timeouts for react methods

Inherited fields
Fields inherited from class	Fields
`class MessageStream`	`serialVersionUID`
`class WithSerialId`	`serialHandle, serialVersionUID`

Constructor Summary

Constructors
Constructor and description
`protected Actor ()`
`protected Actor (DataflowExpression<java.lang.Object> joinLatch)` Constructor to be used by deserialization
`protected Actor (DataflowExpression<java.lang.Object> joinLatch, PGroup parallelGroup)`

Methods Summary

Methods
Type	Name and description
`private boolean`	`callDynamic(java.lang.String method, java.lang.Object[] args)`
`protected ActorMessage`	`createActorMessage(java.lang.Object message)`
`protected RemoteHandle`	`createRemoteHandle(SerialHandle handle, SerialContext host)`
`protected static void`	`deregisterCurrentActorWithThread()` Deregisters the actor registered from the thread
`DataflowExpression<java.lang.Object>`	`getJoinLatch()` Join-point for this actor
`PGroup`	`getParallelGroup()` Retrieves the group to which the actor belongs
`protected void`	`handleException(java.lang.Throwable exception)`
`protected void`	`handleInterrupt(java.lang.InterruptedException exception)`
`protected void`	`handleStart()`
`protected void`	`handleTermination()`
`protected void`	`handleTimeout()`
`protected boolean`	`hasBeenStopped()`
`boolean`	`isActive()` Checks the current status of the Actor.
`boolean`	`isActorThread()` Checks whether the current thread is the actor's current thread.
`void`	`join()` Joins the actor.
`void`	`join(MessageStream listener)` Notify listener when finished
`void`	`join(long timeout, java.util.concurrent.TimeUnit unit)` Joins the actor.
`void`	`join(groovy.time.BaseDuration duration)` Joins the actor.
`void`	`onStop(groovy.lang.Closure onStop)` Set on stop handler for this actor
`protected static void`	`registerCurrentActorWithThread(Actor currentActor)` Registers the actor with the current thread
`MessageStream`	`sendAndContinue(T message, groovy.lang.Closure closure)` Sends a message and execute continuation when reply became available.
`Promise<java.lang.Object>`	`sendAndPromise(T message)` Sends a message and returns a promise for the reply.
`void`	`setParallelGroup(PGroup group)` Sets the parallel group.
`Actor`	`silentStart()` Starts the Actor without sending the START_MESSAGE message to speed the start-up.
`Actor`	`start()` Starts the Actor and sends it the START_MESSAGE to run any afterStart handlers.
`Actor`	`stop()` Send message to stop to the Actor.
`protected ActorMessage`	`sweepNextMessage()` Removes the head of the message queue
`java.util.List<ActorMessage>`	`sweepQueue()` Clears the message queue returning all the messages it held.
`Actor`	`terminate()` Terminates the Actor.
`static Actor`	`threadBoundActor()` Retrieves the actor registered with the current thread

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class MessageStream`	`call, getRemoteClass, leftShift, reInterrupt, send, send, send, sendAndWait, sendAndWait, sendAndWait`
`class WithSerialId`	`createRemoteHandle, getOrCreateSerialHandle, getRemoteClass, writeReplace`
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final java.lang.String ACTOR_HAS_ALREADY_BEEN_STARTED
  - private static final java.lang.String AFTER_START
  - public static final java.lang.String CANNOT_SEND_REPLIES_NO_SENDER_HAS_BEEN_REGISTERED
  - private static final java.lang.Object[] EMPTY_ARGUMENTS
  - private static final java.lang.String ON_DELIVERY_ERROR
  - private static final java.lang.String RESPONDS_TO
  - protected static final ActorMessage START_MESSAGE
  - protected static final ActorMessage STOP_MESSAGE
  - protected static final ActorMessage TERMINATE_MESSAGE
  - @java.lang.SuppressWarnings({"ConstantDeclaredInAbstractClass"}) public static final java.lang.String TIMEOUT
  - protected static final ActorMessage TIMEOUT_MESSAGE
  - private static final java.lang.ThreadLocal<Actor> currentActorPerThread
    
    Maps each thread to the actor it currently processes. Used in the send() method to remember the sender of each message for potential replies
  - protected java.lang.Thread currentThread
  - private final DataflowExpression<java.lang.Object> joinLatch
  - private groovy.lang.Closure onStop
  - protected PGroup parallelGroup
    
    The parallel group to which the message stream belongs
  - private static final long serialVersionUID
  - protected static final GeneralTimer timer
    
    Timer holding timeouts for react methods
- Constructor Detail
  - protected Actor()
  - protected Actor(DataflowExpression<java.lang.Object> joinLatch)
    
    Constructor to be used by deserialization
    Parameters:
    joinLatch - The instance of DataflowExpression to use for join operation
  - protected Actor(DataflowExpression<java.lang.Object> joinLatch, PGroup parallelGroup)
- Method Detail
  - private boolean callDynamic(java.lang.String method, java.lang.Object[] args)
  - protected final ActorMessage createActorMessage(java.lang.Object message)
  - @java.lang.Override protected RemoteHandle createRemoteHandle(SerialHandle handle, SerialContext host)
  - protected static void deregisterCurrentActorWithThread()
    
    Deregisters the actor registered from the thread
  - public DataflowExpression<java.lang.Object> getJoinLatch()
    
    Join-point for this actor
    Returns:
    The DataflowExpression instance, which is used to join this actor
  - public final PGroup getParallelGroup()
    
    Retrieves the group to which the actor belongs
    Returns:
    The group
  - @java.lang.SuppressWarnings({"UseOfSystemOutOrSystemErr"}) protected void handleException(java.lang.Throwable exception)
  - @java.lang.SuppressWarnings({"TypeMayBeWeakened", "UseOfSystemOutOrSystemErr"}) protected void handleInterrupt(java.lang.InterruptedException exception)
  - @java.lang.SuppressWarnings("unchecked") protected void handleStart()
  - protected void handleTermination()
  - protected void handleTimeout()
  - protected boolean hasBeenStopped()
  - public boolean isActive()
    
    Checks the current status of the Actor.
    Returns:
    current status of the Actor.
  - public final boolean isActorThread()
    
    Checks whether the current thread is the actor's current thread.
    Returns:
    True if invoked from within an actor thread
  - public final void join()
    
    Joins the actor. Waits for its termination.
    throws:
    InterruptedException when interrupted while waiting
  - public final void join(MessageStream listener)
    
    Notify listener when finished
    Parameters:
    listener - listener to notify
  - public final void join(long timeout, java.util.concurrent.TimeUnit unit)
    
    Joins the actor. Waits for its termination.
    throws:
    InterruptedException if interrupted while waiting
    
    Parameters:
    timeout - timeout
    unit - units of timeout
  - public final void join(groovy.time.BaseDuration duration)
    
    Joins the actor. Waits for its termination.
    throws:
    InterruptedException if interrupted while waiting
    
    Parameters:
    duration - timeout to wait
  - public final void onStop(groovy.lang.Closure onStop)
    
    Set on stop handler for this actor
    Parameters:
    onStop - The code to invoke when stopping
  - protected static void registerCurrentActorWithThread(Actor currentActor)
    
    Registers the actor with the current thread
    Parameters:
    currentActor - The actor to register
  - @java.lang.SuppressWarnings({"AssignmentToMethodParameter"}) public final MessageStream sendAndContinue(T message, groovy.lang.Closure closure)
    
    Sends a message and execute continuation when reply became available.
    Returns:
    The message that came in reply to the original send.
    Parameters:
    message - message to send
    closure - closure to execute when reply became available
  - @java.lang.SuppressWarnings({"AssignmentToMethodParameter"}) public final Promise<java.lang.Object> sendAndPromise(T message)
    
    Sends a message and returns a promise for the reply.
    Returns:
    The message that came in reply to the original send.
    Parameters:
    message - message to send
  - public void setParallelGroup(PGroup group)
    
    Sets the parallel group. It can only be invoked before the actor is started.
    Parameters:
    group - new group
  - public Actor silentStart()
    
    Starts the Actor without sending the START_MESSAGE message to speed the start-up. The potential custom afterStart handlers won't be run. No messages can be sent or received before an Actor is started.
    Returns:
    same actor
  - public Actor start()
    
    Starts the Actor and sends it the START_MESSAGE to run any afterStart handlers. No messages can be sent or received before an Actor is started.
    Returns:
    same actor
  - public Actor stop()
    
    Send message to stop to the Actor. The actor will finish processing the current message and all unprocessed messages will be passed to the afterStop method, if such exists. No new messages will be accepted since that point. Has no effect if the Actor is not started.
    Returns:
    same actor
  - protected ActorMessage sweepNextMessage()
    
    Removes the head of the message queue
    Returns:
    The head message, or null, if the message queue is empty
  - @java.lang.SuppressWarnings("unchecked") final java.util.List<ActorMessage> sweepQueue()
    
    Clears the message queue returning all the messages it held.
    Returns:
    The messages stored in the queue
  - public Actor terminate()
    
    Terminates the Actor. Unprocessed messages will be passed to the afterStop method, if exists. No new messages will be accepted since that point. Has no effect if the Actor is not started.
    Returns:
    same actor
  - public static Actor threadBoundActor()
    
    Retrieves the actor registered with the current thread
    Returns:
    The associated actor

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class Actor

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final java.lang.String ACTOR_HAS_ALREADY_BEEN_STARTED

private static final java.lang.String AFTER_START

public static final java.lang.String CANNOT_SEND_REPLIES_NO_SENDER_HAS_BEEN_REGISTERED

private static final java.lang.Object[] EMPTY_ARGUMENTS

private static final java.lang.String ON_DELIVERY_ERROR

private static final java.lang.String RESPONDS_TO

protected static final ActorMessage START_MESSAGE

protected static final ActorMessage STOP_MESSAGE

protected static final ActorMessage TERMINATE_MESSAGE

@java.lang.SuppressWarnings({"ConstantDeclaredInAbstractClass"}) public static final java.lang.String TIMEOUT

protected static final ActorMessage TIMEOUT_MESSAGE

private static final java.lang.ThreadLocal<Actor> currentActorPerThread

protected java.lang.Thread currentThread

private final DataflowExpression<java.lang.Object> joinLatch

private groovy.lang.Closure onStop

protected PGroup parallelGroup

private static final long serialVersionUID

protected static final GeneralTimer timer

Constructor Detail

protected Actor()

protected Actor(DataflowExpression<java.lang.Object> joinLatch)

protected Actor(DataflowExpression<java.lang.Object> joinLatch, PGroup parallelGroup)

Method Detail

private boolean callDynamic(java.lang.String method, java.lang.Object[] args)

protected final ActorMessage createActorMessage(java.lang.Object message)

@java.lang.Override protected RemoteHandle createRemoteHandle(SerialHandle handle, SerialContext host)

protected static void deregisterCurrentActorWithThread()

public DataflowExpression<java.lang.Object> getJoinLatch()

public final PGroup getParallelGroup()

@java.lang.SuppressWarnings({"UseOfSystemOutOrSystemErr"}) protected void handleException(java.lang.Throwable exception)

@java.lang.SuppressWarnings({"TypeMayBeWeakened", "UseOfSystemOutOrSystemErr"}) protected void handleInterrupt(java.lang.InterruptedException exception)

@java.lang.SuppressWarnings("unchecked") protected void handleStart()

protected void handleTermination()

protected void handleTimeout()

protected boolean hasBeenStopped()

public boolean isActive()

public final boolean isActorThread()

public final void join()

public final void join(MessageStream listener)

public final void join(long timeout, java.util.concurrent.TimeUnit unit)

public final void join(groovy.time.BaseDuration duration)

public final void onStop(groovy.lang.Closure onStop)

protected static void registerCurrentActorWithThread(Actor currentActor)

@java.lang.SuppressWarnings({"AssignmentToMethodParameter"}) public final MessageStream sendAndContinue(T message, groovy.lang.Closure closure)

@java.lang.SuppressWarnings({"AssignmentToMethodParameter"}) public final Promise<java.lang.Object> sendAndPromise(T message)

public void setParallelGroup(PGroup group)

public Actor silentStart()

public Actor start()

public Actor stop()

protected ActorMessage sweepNextMessage()

@java.lang.SuppressWarnings("unchecked") final java.util.List<ActorMessage> sweepQueue()

public Actor terminate()

public static Actor threadBoundActor()