groovyx.gpars.actor.impl
Class SequentialProcessingActor

java.lang.Object
  groovyx.gpars.serial.WithSerialId
      groovyx.gpars.actor.impl.MessageStream
          groovyx.gpars.actor.Actor
              groovyx.gpars.actor.impl.ReplyingMessageStream
                  groovyx.gpars.actor.impl.SequentialProcessingActor

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable

Direct Known Subclasses:

AbstractPooledActor

Deprecated.

@Deprecated
public abstract class SequentialProcessingActor
extends ReplyingMessageStream
implements java.lang.Runnable

Author:

Alex Tkachman, Vaclav Pech

See Also:

Serialized Form

Nested Class Summary

private class	SequentialProcessingActor.MultiMessageReaction Deprecated. Enables multiple argument closures to be passed to react().
private static class	SequentialProcessingActor.Node Deprecated. Represents an element in the message queue.
private static class	SequentialProcessingActor.Reaction Deprecated. Buffers messages for the next continuation of an event-driven actor, handles timeouts and no-param continuations.

Nested classes/interfaces inherited from class groovyx.gpars.actor.Actor

Actor.MyRemoteHandle, Actor.RemoteActor

Nested classes/interfaces inherited from class groovyx.gpars.actor.impl.MessageStream

MessageStream.RemoteMessageStream, MessageStream.SendTo

Field Summary

protected groovy.lang.Closure	afterLoopCode Deprecated.
private int	count Deprecated. Counter of messages in the queues
private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<SequentialProcessingActor>	countUpdater Deprecated.
private static java.lang.String	ERROR_EVALUATING_LOOP_CONDITION Deprecated.
private SequentialProcessingActor.Node	inputQueue Deprecated. Stored incoming messages.
private static java.util.concurrent.atomic.AtomicReferenceFieldUpdater<SequentialProcessingActor,SequentialProcessingActor.Node>	inputQueueUpdater Deprecated.
protected java.lang.Runnable	loopCode Deprecated. Code for the loop, if any
protected java.util.concurrent.Callable<java.lang.Boolean>	loopCondition Deprecated.
private static ActorMessage	loopMessage Deprecated.
private java.util.concurrent.atomic.AtomicBoolean	ongoingThreadTermination Deprecated.
private SequentialProcessingActor.Node	outputQueue Deprecated. Stores messages ready for processing by the actor.
private SequentialProcessingActor.Reaction	reaction Deprecated. Code for the next action
protected static int	S_ACTIVE_MASK Deprecated.
protected static int	S_FINISHED_MASK Deprecated.
protected static int	S_FINISHING_MASK Deprecated.
protected static int	S_NOT_STARTED Deprecated.
protected static int	S_RUNNING Deprecated.
protected static int	S_STOP_TERMINATE_MASK Deprecated.
protected static int	S_STOPPED Deprecated.
protected static int	S_STOPPING Deprecated.
protected static int	S_TERMINATED Deprecated.
protected static int	S_TERMINATING Deprecated.
private static long	serialVersionUID Deprecated.
private static java.lang.String	SHOULD_NOT_REACH_HERE Deprecated.
private static ActorMessage	startMessage Deprecated.
protected int	stopFlag Deprecated. Indicates whether the actor should terminate
protected static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<SequentialProcessingActor>	stopFlagUpdater Deprecated.
private java.lang.Thread	waitingThread Deprecated.

Fields inherited from class groovyx.gpars.actor.impl.ReplyingMessageStream

obj2Sender

Fields inherited from class groovyx.gpars.actor.Actor

ACTOR_HAS_ALREADY_BEEN_STARTED, currentThread, parallelGroup, START_MESSAGE, STOP_MESSAGE, TERMINATE_MESSAGE, TIMEOUT, TIMEOUT_MESSAGE, timer

Fields inherited from class groovyx.gpars.serial.WithSerialId

serialHandle

Constructor Summary

protected

SequentialProcessingActor() Deprecated. Creates a new instance, sets the default actor group.

Method Summary

private ActorMessage	awaitNextMessage(long endTime) Deprecated. Holds common functionality for takeMessage() methods.
private void	doLoopCall() Deprecated.
private ActorMessage	getMessage() Deprecated. Retrieves the next message from the queue
protected void	handleTermination() Deprecated.
protected boolean	hasBeenStopped() Deprecated.
protected void	checkStopTerminate() Deprecated.
boolean	isActive() Deprecated. Checks the current status of the Actor.
private void	loop(java.util.concurrent.Callable<java.lang.Boolean> condition, groovy.lang.Closure afterLoopCode, java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected void	loop(groovy.lang.Closure condition, groovy.lang.Closure afterLoopCode, java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected void	loop(groovy.lang.Closure condition, java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected void	loop(int numberOfLoops, groovy.lang.Closure afterLoopCode, java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected void	loop(int numberOfLoops, java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected void	loop(java.lang.Runnable code) Deprecated. Ensures that the supplied closure will be invoked repeatedly in a loop.
protected ActorMessage	pollMessage() Deprecated. Polls a message from the queues
protected void	react(groovy.lang.Closure code) Deprecated. Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure.
protected void	react(groovy.time.Duration duration, groovy.lang.Closure code) Deprecated. Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure.
protected void	react(long timeout, groovy.lang.Closure code) Deprecated. Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure.
protected void	react(long timeout, java.util.concurrent.TimeUnit timeUnit, groovy.lang.Closure code) Deprecated. Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure.
protected java.lang.Object	receive() Deprecated. Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
protected java.lang.Object	receive(groovy.time.BaseDuration duration) Deprecated. Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
protected java.lang.Object	receive(long timeout, java.util.concurrent.TimeUnit units) Deprecated. Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
protected abstract java.lang.Object	receiveImpl() Deprecated. Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
protected abstract java.lang.Object	receiveImpl(long timeout, java.util.concurrent.TimeUnit units) Deprecated. Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
private ActorMessage	retrieveNextMessage() Deprecated. Takes the next message from the outputQueue, decrements the counter and possibly throws control exceptions
void	run() Deprecated.
(package private) void	runReaction(ActorMessage message, groovy.lang.Closure code) Deprecated.
MessageStream	send(java.lang.Object message) Deprecated. Send message to stream and return immediately
void	setParallelGroup(groovyx.gpars.group.PGroup group) Deprecated. Sets the actor's group.
private void	schedule() Deprecated. Schedules the current actor for processing on the actor group's thread pool.
protected void	scheduleLoop() Deprecated.
Actor	silentStart() Deprecated. Starts the Actor without sending the START_MESSAGE message to speed the start-up.
SequentialProcessingActor	start() Deprecated. Starts the Actor.
Actor	stop() Deprecated. Send message to stop to the actor.
protected ActorMessage	sweepNextMessage() Deprecated. Removes the head of the message queue
protected ActorMessage	takeMessage() Deprecated. Takes a message from the queues.
protected ActorMessage	takeMessage(long timeout, java.util.concurrent.TimeUnit timeUnit) Deprecated. Takes a message from the queues.
Actor	terminate() Deprecated. Terminate the Actor.
private void	throwIfNeeded(ActorMessage toProcess) Deprecated. Checks the supplied message and throws either STOP or TERMINATE, if the message is a Stop or Terminate message respectively.
private void	transferQueues() Deprecated. Transfers messages from the input queue into the output queue, reverting the order of the elements.
private static java.lang.Object	unwrapMessage(java.lang.Object msg) Deprecated.
private static boolean	verifyLoopCondition(java.util.concurrent.Callable<java.lang.Boolean> condition) Deprecated.

Methods inherited from class groovyx.gpars.actor.impl.ReplyingMessageStream

getSender, getSenders, reply, replyIfExists, runEnhancedWithRepliesOnMessages

Methods inherited from class groovyx.gpars.actor.Actor

createActorMessage, createRemoteHandle, deregisterCurrentActorWithThread, getJoinLatch, getParallelGroup, handleException, handleInterrupt, handleStart, handleTimeout, isActorThread, join, join, join, join, onStop, registerCurrentActorWithThread, sendAndContinue, threadBoundActor

Methods inherited from class groovyx.gpars.actor.impl.MessageStream

call, getRemoteClass, leftShift, reInterrupt, send, send, sendAndWait, sendAndWait, sendAndWait

Methods inherited from class groovyx.gpars.serial.WithSerialId

getOrCreateSerialHandle, writeReplace

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

loopCode

protected java.lang.Runnable loopCode

Deprecated.

Code for the loop, if any

afterLoopCode

protected groovy.lang.Closure afterLoopCode

Deprecated.

loopCondition

protected java.util.concurrent.Callable<java.lang.Boolean> loopCondition

Deprecated.

reaction

private volatile SequentialProcessingActor.Reaction reaction

Deprecated.

Code for the next action

inputQueue

private volatile SequentialProcessingActor.Node inputQueue

Deprecated.

Stored incoming messages. The most recently received message is in the head of the list.

outputQueue

private SequentialProcessingActor.Node outputQueue

Deprecated.

Stores messages ready for processing by the actor. The oldest message is in the head of the list. Messages are transferred from the inputQueue into the output queue in the transferQueues() method.

ongoingThreadTermination

private final java.util.concurrent.atomic.AtomicBoolean ongoingThreadTermination

Deprecated.

count

private volatile int count

Deprecated.

Counter of messages in the queues

inputQueueUpdater

private static final java.util.concurrent.atomic.AtomicReferenceFieldUpdater<SequentialProcessingActor,SequentialProcessingActor.Node> inputQueueUpdater

Deprecated.

countUpdater

private static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<SequentialProcessingActor> countUpdater

Deprecated.

waitingThread

private volatile java.lang.Thread waitingThread

Deprecated.

startMessage

private static final ActorMessage startMessage

Deprecated.

loopMessage

private static final ActorMessage loopMessage

Deprecated.

S_ACTIVE_MASK

protected static final int S_ACTIVE_MASK

Deprecated.

See Also:

Constant Field Values

S_FINISHING_MASK

protected static final int S_FINISHING_MASK

Deprecated.

See Also:

Constant Field Values

S_FINISHED_MASK

protected static final int S_FINISHED_MASK

Deprecated.

See Also:

Constant Field Values

S_STOP_TERMINATE_MASK

protected static final int S_STOP_TERMINATE_MASK

Deprecated.

See Also:

Constant Field Values

S_NOT_STARTED

protected static final int S_NOT_STARTED

Deprecated.

See Also:

Constant Field Values

S_RUNNING

protected static final int S_RUNNING

Deprecated.

See Also:

Constant Field Values

S_STOPPING

protected static final int S_STOPPING

Deprecated.

See Also:

Constant Field Values

S_TERMINATING

protected static final int S_TERMINATING

Deprecated.

See Also:

Constant Field Values

S_STOPPED

protected static final int S_STOPPED

Deprecated.

See Also:

Constant Field Values

S_TERMINATED

protected static final int S_TERMINATED

Deprecated.

See Also:

Constant Field Values

stopFlag

protected volatile int stopFlag

Deprecated.

Indicates whether the actor should terminate

stopFlagUpdater

protected static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<SequentialProcessingActor> stopFlagUpdater

Deprecated.

SHOULD_NOT_REACH_HERE

private static final java.lang.String SHOULD_NOT_REACH_HERE

Deprecated.

See Also:

Constant Field Values

ERROR_EVALUATING_LOOP_CONDITION

private static final java.lang.String ERROR_EVALUATING_LOOP_CONDITION

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SequentialProcessingActor

protected SequentialProcessingActor()

Deprecated.

Creates a new instance, sets the default actor group.

Method Detail

isActive

public final boolean isActive()

Deprecated.

Checks the current status of the Actor.

Specified by:

isActive in class Actor

Returns:

current status of the Actor.

getMessage

private ActorMessage getMessage()

Deprecated.

Retrieves the next message from the queue

Returns:

The message

throwIfNeeded

private void throwIfNeeded(ActorMessage toProcess)

Deprecated.

Checks the supplied message and throws either STOP or TERMINATE, if the message is a Stop or Terminate message respectively.

Parameters:

toProcess - The next message to process by the actors

pollMessage

protected final ActorMessage pollMessage()

Deprecated.

Polls a message from the queues

Returns:

The message

takeMessage

protected final ActorMessage takeMessage()
                                  throws java.lang.InterruptedException

Deprecated.

Takes a message from the queues. Blocks until a message is available.

Returns:

The message

Throws:

java.lang.InterruptedException - If the thread gets interrupted.

takeMessage

protected ActorMessage takeMessage(long timeout,
                                   java.util.concurrent.TimeUnit timeUnit)
                            throws java.lang.InterruptedException

Deprecated.

Takes a message from the queues. Blocks until a message is available.

Parameters:

timeout - Max time to wait for a message

timeUnit - The units for the timeout

Returns:

The message

Throws:

java.lang.InterruptedException - If the thread gets interrupted.

awaitNextMessage

private ActorMessage awaitNextMessage(long endTime)
                               throws java.lang.InterruptedException

Deprecated.

Holds common functionality for takeMessage() methods.

Parameters:

endTime - End of the timeout, 0 if no timeout was set

Returns:

The next message

Throws:

java.lang.InterruptedException - If the thread has been interrupted

retrieveNextMessage

private ActorMessage retrieveNextMessage()

Deprecated.

Takes the next message from the outputQueue, decrements the counter and possibly throws control exceptions

Returns:

The next message

transferQueues

private void transferQueues()

Deprecated.

Transfers messages from the input queue into the output queue, reverting the order of the elements.

setParallelGroup

public final void setParallelGroup(groovyx.gpars.group.PGroup group)

Deprecated.

Sets the actor's group. It can only be invoked before the actor is started.

Overrides:

setParallelGroup in class Actor

Parameters:

group - new group

send

public final MessageStream send(java.lang.Object message)

Deprecated.

Description copied from class: MessageStream

Send message to stream and return immediately

Specified by:

send in class MessageStream

Parameters:

message - message to send

Returns:

always return message stream itself

hasBeenStopped

protected final boolean hasBeenStopped()

Deprecated.

Specified by:

hasBeenStopped in class Actor

schedule

private void schedule()

Deprecated.

Schedules the current actor for processing on the actor group's thread pool.

scheduleLoop

protected void scheduleLoop()

Deprecated.

handleTermination

protected void handleTermination()

Deprecated.

Overrides:

handleTermination in class Actor

silentStart

public Actor silentStart()

Deprecated.

Description copied from class: Actor

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.

Specified by:

silentStart in class Actor

Returns:

same actor

start

public final SequentialProcessingActor start()

Deprecated.

Starts the Actor. No messages can be send or received before an Actor is started.

Specified by:

start in class Actor

Returns:

this (the actor itself) to allow method chaining

stop

public final Actor stop()

Deprecated.

Send message to stop to the actor. All messages in queue will be processed before stopped but no new messages will be accepted after that point

Specified by:

stop in class Actor

Returns:

this (the actor itself) to allow method chaining

terminate

public final Actor terminate()

Deprecated.

Terminate the Actor. The background thread will be interrupted, unprocessed messages will be passed to the afterStop method, if exists. Has no effect if the Actor is not started.

Specified by:

terminate in class Actor

Returns:

this (the actor itself) to allow method chaining

react

protected final void react(groovy.time.Duration duration,
                           groovy.lang.Closure code)

Deprecated.

Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

duration - Time to wait at most for a message to arrive. The actor terminates if a message doesn't arrive within the given timeout. The TimeCategory DSL to specify timeouts must be enabled explicitly inside the Actor's act() method.

code - The code to handle the next message. The reply() and replyIfExists() methods are available inside the closure to send a reply back to the actor, which sent the original message.

react

protected final void react(groovy.lang.Closure code)

Deprecated.

Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

code - The code to handle the next message. The reply() and replyIfExists() methods are available inside the closure to send a reply back to the actor, which sent the original message.

react

protected final void react(long timeout,
                           java.util.concurrent.TimeUnit timeUnit,
                           groovy.lang.Closure code)

Deprecated.

Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

timeout - Time in milliseconds to wait at most for a message to arrive. The actor terminates if a message doesn't arrive within the given timeout.

timeUnit - a TimeUnit determining how to interpret the timeout parameter

code - The code to handle the next message. The reply() and replyIfExists() methods are available inside the closure to send a reply back to the actor, which sent the original message.

react

protected final void react(long timeout,
                           groovy.lang.Closure code)

Deprecated.

Schedules an ActorAction to take the next message off the message queue and to pass it on to the supplied closure. The method never returns, but instead frees the processing thread back to the thread pool. Also adds reply() and replyIfExists() methods to the currentActor and the message. These methods will call send() on the target actor (the sender of the original message). The reply()/replyIfExists() methods invoked on the actor will be sent to all currently processed messages, reply()/replyIfExists() invoked on a message will send a reply to the sender of that particular message only.

Parameters:

timeout - Time in milliseconds to wait at most for a message to arrive. The actor terminates if a message doesn't arrive within the given timeout.

code - The code to handle the next message. The reply() and replyIfExists() methods are available inside the closure to send a reply back to the actor, which sent the original message.

receiveImpl

protected abstract java.lang.Object receiveImpl()
                                         throws java.lang.InterruptedException

Deprecated.

Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Returns:

The message retrieved from the queue, or null, if the timeout expires.

Throws:

java.lang.InterruptedException - If the thread is interrupted during the wait. Should propagate up to stop the thread.

receiveImpl

protected abstract java.lang.Object receiveImpl(long timeout,
                                                java.util.concurrent.TimeUnit units)
                                         throws java.lang.InterruptedException

Deprecated.

Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Parameters:

timeout - how long to wait before giving up, in units of unit

units - a TimeUnit determining how to interpret the timeout parameter

Returns:

The message retrieved from the queue, or null, if the timeout expires.

Throws:

java.lang.InterruptedException - If the thread is interrupted during the wait. Should propagate up to stop the thread.

receive

protected final java.lang.Object receive()
                                  throws java.lang.InterruptedException

Deprecated.

Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Returns:

The message retrieved from the queue, or null, if the timeout expires.

Throws:

java.lang.InterruptedException - If the thread is interrupted during the wait. Should propagate up to stop the thread.

receive

protected final java.lang.Object receive(long timeout,
                                         java.util.concurrent.TimeUnit units)
                                  throws java.lang.InterruptedException

Deprecated.

Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Parameters:

timeout - how long to wait before giving up, in units of unit

units - a TimeUnit determining how to interpret the timeout parameter

Returns:

The message retrieved from the queue, or null, if the timeout expires.

Throws:

java.lang.InterruptedException - If the thread is interrupted during the wait. Should propagate up to stop the thread.

unwrapMessage

private static java.lang.Object unwrapMessage(java.lang.Object msg)

Deprecated.

receive

protected final java.lang.Object receive(groovy.time.BaseDuration duration)
                                  throws java.lang.InterruptedException

Deprecated.

Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Parameters:

duration - how long to wait before giving up, in units of unit

Returns:

The message retrieved from the queue, or null, if the timeout expires.

Throws:

java.lang.InterruptedException - If the thread is interrupted during the wait. Should propagate up to stop the thread.

sweepNextMessage

protected final ActorMessage sweepNextMessage()

Deprecated.

Removes the head of the message queue

Specified by:

sweepNextMessage in class Actor

Returns:

The head message, or null, if the message queue is empty

run

public void run()

Deprecated.

Specified by:

run in interface java.lang.Runnable

loop

protected final void loop(java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

code - The closure to invoke repeatedly

loop

protected final void loop(int numberOfLoops,
                          java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

numberOfLoops - The loop will only be run the given number of times

code - The closure to invoke repeatedly

loop

protected final void loop(int numberOfLoops,
                          groovy.lang.Closure afterLoopCode,
                          java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

numberOfLoops - The loop will only be run the given number of times

afterLoopCode - Code to run after the main actor's loop finishes

code - The closure to invoke repeatedly

loop

protected final void loop(groovy.lang.Closure condition,
                          java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

condition - A condition to evaluate before each iteration starts. If the condition returns false, the loop exits.

code - The closure to invoke repeatedly

loop

protected final void loop(groovy.lang.Closure condition,
                          groovy.lang.Closure afterLoopCode,
                          java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

condition - A condition to evaluate before each iteration starts. If the condition returns false, the loop exits.

afterLoopCode - Code to run after the main actor's loop finishes

code - The closure to invoke repeatedly

loop

private void loop(java.util.concurrent.Callable<java.lang.Boolean> condition,
                  groovy.lang.Closure afterLoopCode,
                  java.lang.Runnable code)

Deprecated.

Ensures that the supplied closure will be invoked repeatedly in a loop. The method never returns, but instead frees the processing thread back to the thread pool.

Parameters:

condition - A condition to evaluate before each iteration starts. If the condition returns false, the loop exits.

afterLoopCode - Code to run after the main actor's loop finishes

code - The closure to invoke repeatedly

verifyLoopCondition

private static boolean verifyLoopCondition(java.util.concurrent.Callable<java.lang.Boolean> condition)

Deprecated.

doLoopCall

private void doLoopCall()

Deprecated.

runReaction

final void runReaction(ActorMessage message,
                       groovy.lang.Closure code)

Deprecated.

checkStopTerminate

protected final void checkStopTerminate()

Deprecated.