AbstractLoopingActor (org.codehaus.gpars)

groovyx.gpars.actor.AbstractLoopingActor

Wraps all actors that repeatedly loop through incoming messages and hold no implicit state between subsequent messages.
Authors:
Vaclav Pech Date: Aug 23, 2010

Field Summary

Fields
Modifiers	Name	Description
`private AsyncMessagingCore`	`core`	Holds the particular instance of async messaging core to use
`private MessageStream`	`currentSender`
`private ActorTimerTask`	`currentTimerTask`
`private static long`	`serialVersionUID`
`private boolean`	`stoppedFlag`
`private boolean`	`terminatedFlag`
`boolean`	`terminatingFlag`
`private int`	`timeoutCounter`

Inherited fields
Fields inherited from class	Fields
`class Actor`	`ACTOR_HAS_ALREADY_BEEN_STARTED, AFTER_START, CANNOT_SEND_REPLIES_NO_SENDER_HAS_BEEN_REGISTERED, EMPTY_ARGUMENTS, ON_DELIVERY_ERROR, RESPONDS_TO, START_MESSAGE, STOP_MESSAGE, TERMINATE_MESSAGE, TIMEOUT, TIMEOUT_MESSAGE, currentActorPerThread, currentThread, joinLatch, onStop, parallelGroup, serialVersionUID, timer`
`class MessageStream`	`serialVersionUID`
`class WithSerialId`	`serialHandle, serialVersionUID`

Constructor Summary

Constructors
Constructor and description
`AbstractLoopingActor ()`

Methods Summary

Methods
Type	Name and description
`private void`	`cancelCurrentTimeoutTask()`
`private Actor`	`doStart()`
`AsyncMessagingCore`	`getCore()`
`MessageStream`	`getSender()` Retrieves the sender actor of the currently processed message.
`protected boolean`	`hasBeenStopped()`
`protected void`	`initialize(groovy.lang.Closure code)` Builds the async messaging core using the supplied code handler
`boolean`	`isActive()`
`boolean`	`isFair()` Retrieves the actor's fairness flag Fair actors give up the thread after processing each message, non-fair actors keep a thread until their message queue is empty.
`void`	`makeFair()` Makes the actor fair.
`void`	`reply(java.lang.Object message)` Sends a reply to all currently processed messages.
`void`	`replyIfExists(java.lang.Object message)` Sends a reply to all currently processed messages, which have been sent by an actor.
`private void`	`runEnhancedWithoutRepliesOnMessages(ActorMessage message, groovy.lang.Closure code, java.lang.Object arguments)`
`MessageStream`	`send(java.lang.Object message)`
`void`	`setParallelGroup(PGroup group)`
`protected void`	`setTimeout(long timeout)`
`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()`
`protected ActorMessage`	`sweepNextMessage()` Removes the head of the message queue
`Actor`	`terminate()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Actor`	`callDynamic, createActorMessage, createRemoteHandle, deregisterCurrentActorWithThread, getJoinLatch, getParallelGroup, handleException, handleInterrupt, handleStart, handleTermination, handleTimeout, hasBeenStopped, isActive, isActorThread, join, join, join, join, onStop, registerCurrentActorWithThread, sendAndContinue, sendAndPromise, setParallelGroup, silentStart, start, stop, sweepNextMessage, sweepQueue, terminate, threadBoundActor`
`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
  - private AsyncMessagingCore core
    
    Holds the particular instance of async messaging core to use
  - private MessageStream currentSender
  - private ActorTimerTask currentTimerTask
  - private static final long serialVersionUID
  - private boolean stoppedFlag
  - private boolean terminatedFlag
  - boolean terminatingFlag
  - private int timeoutCounter
- Constructor Detail
  - AbstractLoopingActor()
- Method Detail
  - private void cancelCurrentTimeoutTask()
  - private Actor doStart()
  - final AsyncMessagingCore getCore()
  - public final MessageStream getSender()
    
    Retrieves the sender actor of the currently processed message.
    throws:
    groovyx.gpars.actor.impl.ActorReplyException If some of the replies failed to be sent.
    
    Returns:
    The sender of the currently processed message or null, if the message was not sent by an actor
  - @java.lang.Override protected final boolean hasBeenStopped()
  - protected final void initialize(groovy.lang.Closure code)
    
    Builds the async messaging core using the supplied code handler
    Parameters:
    code - Code to run on each message
  - @java.lang.Override public final boolean isActive()
  - public final boolean isFair()
    
    Retrieves the actor's fairness flag Fair actors give up the thread after processing each message, non-fair actors keep a thread until their message queue is empty. Non-fair actors tend to perform better than fair ones.
    Returns:
    True for fair actors, false for non-fair ones. actors are non-fair by default.
  - public final void makeFair()
    
    Makes the actor fair. Actors are non-fair by default. Fair actors give up the thread after processing each message, non-fair actors keep a thread until their message queue is empty. Non-fair actors tend to perform better than fair ones.
  - public final void reply(java.lang.Object message)
    
    Sends a reply to all currently processed messages. Throws ActorReplyException if some messages have not been sent by an actor. For such cases use replyIfExists().
    throws:
    groovyx.gpars.actor.impl.ActorReplyException If some of the replies failed to be sent.
    
    Parameters:
    message - reply message
  - public final void replyIfExists(java.lang.Object message)
    
    Sends a reply to all currently processed messages, which have been sent by an actor. Ignores potential errors when sending the replies, like no sender or sender already stopped.
    Parameters:
    message - reply message
  - private void runEnhancedWithoutRepliesOnMessages(ActorMessage message, groovy.lang.Closure code, java.lang.Object arguments)
  - @java.lang.Override public MessageStream send(java.lang.Object message)
  - @java.lang.Override public void setParallelGroup(PGroup group)
  - protected final void setTimeout(long timeout)
  - @java.lang.Override 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
  - @java.lang.Override 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
  - @java.lang.Override public final Actor stop()
  - @java.lang.Override protected ActorMessage sweepNextMessage()
    
    Removes the head of the message queue
    Returns:
    The head message, or null, if the message queue is empty
  - @java.lang.Override public final Actor terminate()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class AbstractLoopingActor

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private AsyncMessagingCore core

private MessageStream currentSender

private ActorTimerTask currentTimerTask

private static final long serialVersionUID

private boolean stoppedFlag

private boolean terminatedFlag

boolean terminatingFlag

private int timeoutCounter

Constructor Detail

AbstractLoopingActor()

Method Detail

private void cancelCurrentTimeoutTask()

private Actor doStart()

final AsyncMessagingCore getCore()

public final MessageStream getSender()

@java.lang.Override protected final boolean hasBeenStopped()

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

@java.lang.Override public final boolean isActive()

public final boolean isFair()

public final void makeFair()

public final void reply(java.lang.Object message)

public final void replyIfExists(java.lang.Object message)

private void runEnhancedWithoutRepliesOnMessages(ActorMessage message, groovy.lang.Closure code, java.lang.Object arguments)

@java.lang.Override public MessageStream send(java.lang.Object message)

@java.lang.Override public void setParallelGroup(PGroup group)

protected final void setTimeout(long timeout)

@java.lang.Override public Actor silentStart()

@java.lang.Override public Actor start()

@java.lang.Override public final Actor stop()

@java.lang.Override protected ActorMessage sweepNextMessage()

@java.lang.Override public final Actor terminate()