BlockingActor (org.codehaus.gpars)

groovyx.gpars.actor.BlockingActor

Authors:
Vaclav Pech, Alex Tkachman, Dierk Koenig

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`AN_ACTOR_CAN_ONLY_RECEIVE_ONE_MESSAGE_AT_A_TIME`
`private static java.lang.String`	`THE_ACTOR_HAS_BEEN_STOPPED`
`private static java.lang.String`	`THE_ACTOR_HAS_NOT_BEEN_STARTED`
`private static long`	`serialVersionUID`

Inherited fields
Fields inherited from class	Fields
`class SequentialProcessingActor`	`SHOULD_NOT_REACH_HERE, S_ACTIVE_MASK, S_FINISHED_MASK, S_FINISHING_MASK, S_NOT_STARTED, S_RUNNING, S_STOPPED, S_STOPPING, S_STOP_TERMINATE_MASK, S_TERMINATED, S_TERMINATING, inputQueue, inputQueueUpdater, ongoingThreadTermination, outputQueue, serialVersionUID, stopFlag, stopFlagUpdater, waitingThread`
`class ReplyingMessageStream`	`sender, serialVersionUID`
`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
`BlockingActor ()`

Methods Summary

Methods
Type	Name and description
`private void`	`checkStoppedFlags()`
`private java.lang.Object`	`enhanceAndUnwrap(ActorMessage message)`
`private void`	`enhanceReplies(ActorMessage message)` Adds `reply` and `replyIfExists` methods to the current `Actor` and the message.
`protected void`	`handleStart()`
`protected void`	`receive(groovy.lang.Closure handler)` Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
`protected void`	`receive(long timeout, java.util.concurrent.TimeUnit timeUnit, groovy.lang.Closure handler)` Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
`protected void`	`receive(groovy.time.Duration duration, groovy.lang.Closure handler)` Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
`protected java.lang.Object`	`receiveImpl()` Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
`protected java.lang.Object`	`receiveImpl(long timeout, java.util.concurrent.TimeUnit units)` Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class SequentialProcessingActor`	`act, awaitNextMessage, checkStopTerminate, handleTermination, hasBeenStopped, isActive, pollMessage, receive, receive, receive, receiveImpl, receiveImpl, retrieveNextMessage, run, send, setParallelGroup, silentStart, start, stop, sweepNextMessage, takeMessage, takeMessage, terminate, throwIfNeeded, transferQueues, unwrapMessage`
`class ReplyingMessageStream`	`getSender, reply, replyIfExists, setSender`
`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
  - public static final java.lang.String AN_ACTOR_CAN_ONLY_RECEIVE_ONE_MESSAGE_AT_A_TIME
  - private static final java.lang.String THE_ACTOR_HAS_BEEN_STOPPED
  - private static final java.lang.String THE_ACTOR_HAS_NOT_BEEN_STARTED
  - private static final long serialVersionUID
- Constructor Detail
  - BlockingActor()
- Method Detail
  - private void checkStoppedFlags()
  - private java.lang.Object enhanceAndUnwrap(ActorMessage message)
  - private void enhanceReplies(ActorMessage message)
    
    Adds reply and replyIfExists methods to the current Actor 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:
    message - The original message
  - @java.lang.Override protected void handleStart()
  - @java.lang.SuppressWarnings({"MethodOverloadsMethodOfSuperclass"}) protected final void receive(groovy.lang.Closure handler)
    
    Retrieves a message from the message queue, waiting, if necessary, for a message to arrive. The message retrieved from the queue is passed into the handler as the only parameter.
    throws:
    InterruptedException If the thread is interrupted during the wait. Should propagate up to stop the thread.
    
    Parameters:
    handler - A closure accepting the retrieved message as a parameter, which will be invoked after a message is received.
  - protected final void receive(long timeout, java.util.concurrent.TimeUnit timeUnit, groovy.lang.Closure handler)
    
    Retrieves a message from the message queue, waiting, if necessary, for a message to arrive. The message retrieved from the queue is passed into the handler as the only parameter. A null value is passed into the handler, if the timeout expires
    throws:
    InterruptedException If the thread is interrupted during the wait. Should propagate up to stop the thread.
    
    Parameters:
    timeout - how long to wait before giving up, in units of unit
    timeUnit - a TimeUnit determining how to interpret the timeout parameter
    handler - A closure accepting the retrieved message as a parameter, which will be invoked after a message is received.
  - @java.lang.SuppressWarnings({"MethodOverloadsMethodOfSuperclass", "TypeMayBeWeakened"}) protected final void receive(groovy.time.Duration duration, groovy.lang.Closure handler)
    
    Retrieves a message from the message queue, waiting, if necessary, for a message to arrive. The message retrieved from the queue is passed into the handler as the only parameter. A null value is passed into the handler, if the timeout expires
    throws:
    InterruptedException If the thread is interrupted during the wait. Should propagate up to stop the thread.
    
    Parameters:
    duration - how long to wait before giving up, in units of unit
    handler - A closure accepting the retrieved message as a parameter, which will be invoked after a message is received.
  - @java.lang.Override protected final java.lang.Object receiveImpl()
    
    Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
    throws:
    InterruptedException If the thread is interrupted during the wait. Should propagate up to stop the thread.
    
    Returns:
    The message retrieved from the queue.
  - @java.lang.Override protected final java.lang.Object receiveImpl(long timeout, java.util.concurrent.TimeUnit units)
    
    Retrieves a message from the message queue, waiting, if necessary, for a message to arrive.
    throws:
    InterruptedException If the thread is interrupted during the wait. Should propagate up to stop the thread.
    
    Returns:
    The message retrieved from the queue, or null, if the timeout expires.
    Parameters:
    timeout - how long to wait before giving up, in units of unit
    units - a TimeUnit determining how to interpret the timeout parameter

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class BlockingActor

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String AN_ACTOR_CAN_ONLY_RECEIVE_ONE_MESSAGE_AT_A_TIME

private static final java.lang.String THE_ACTOR_HAS_BEEN_STOPPED

private static final java.lang.String THE_ACTOR_HAS_NOT_BEEN_STARTED

private static final long serialVersionUID

Constructor Detail

BlockingActor()

Method Detail

private void checkStoppedFlags()

private java.lang.Object enhanceAndUnwrap(ActorMessage message)

private void enhanceReplies(ActorMessage message)

@java.lang.Override protected void handleStart()

@java.lang.SuppressWarnings({"MethodOverloadsMethodOfSuperclass"}) protected final void receive(groovy.lang.Closure handler)

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

@java.lang.SuppressWarnings({"MethodOverloadsMethodOfSuperclass", "TypeMayBeWeakened"}) protected final void receive(groovy.time.Duration duration, groovy.lang.Closure handler)

@java.lang.Override protected final java.lang.Object receiveImpl()

@java.lang.Override protected final java.lang.Object receiveImpl(long timeout, java.util.concurrent.TimeUnit units)