AgentBase (org.codehaus.gpars)

groovyx.gpars.agent.AgentBase

Implements most of Agent's public method in Java
Authors:
Vaclav Pech

Nested Class Summary

Nested classes
Modifiers	Name	Description
`private static class`	`AgentBase.AwaitClosure`	Returns the current value of the Agent's state

Field Summary

Fields
Modifiers	Name	Description
`private static groovy.lang.Closure`	`awaitClosure`
`private groovy.lang.Closure`	`copy`	Function converting the internal state during read to prevent internal state escape from the protected boundary of the agent
`protected T`	`data`	Holds the internal mutable state
`private java.util.Collection<groovy.lang.Closure>`	`listeners`	Holds all listeners interested in state updates A listener should be a closure accepting the old and the new value in this order.
`protected java.util.concurrent.locks.ReadWriteLock`	`lock`	Allows reads not to wait in the message queue.
`private java.util.Collection<groovy.lang.Closure>`	`validators`	Holds all validators checking the agent's state A validator should be a closure accepting the old and the new value in this order.

Inherited fields
Fields inherited from class	Fields
`class AgentCore`	`core, currentThread, errors`
`class WithSerialId`	`serialHandle, serialVersionUID`

Constructor Summary

Constructors
Constructor and description
`AgentBase (T data)`
`AgentBase (T data, groovy.lang.Closure copy)` Creates a new Agent around the supplied modifiable object

Methods Summary

Methods
Type	Name and description
`void`	`addListener(groovy.lang.Closure listener)` Adds a listener interested in state updates A listener should be a closure accepting the old and the new value in this order plus optionally the agent reference as the first argument.
`void`	`addValidator(groovy.lang.Closure validator)` Adds a validator checking the agent's state A listener should be a closure accepting the old and the new value in this order plus optionally the agent reference as the first argument.
`void`	`await()` Blocks until all messages in the queue prior to call to await() complete.
`private groovy.lang.Closure`	`checkClosure(groovy.lang.Closure code)` Only two-argument closures are allowed
`T`	`getInstantVal()` A shorthand method for safe message-based retrieval of the internal state.
`T`	`getVal()` A shorthand method for safe message-based retrieval of the internal state.
`void`	`onMessage(org.codehaus.groovy.runtime.NullObject obj)` Accepts a NullObject instance and sets the internal state to null
`void`	`onMessage(groovy.lang.Closure code)` Accepts and invokes the closure
`void`	`onMessage(T message)` Other messages than closures are accepted as new values for the internal state
`T`	`sendAndWait(groovy.lang.Closure message)` Submits the closure waiting for the result
`void`	`updateValue(T newValue)` Allows closures to set the new internal state as a whole Do not call this method directly from the outside.
`void`	`valAsync(groovy.lang.Closure callback)` A shorthand method for safe asynchronous message-based retrieval of the internal state.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AgentCore`	`attachToThreadPool, call, getErrors, handleMessage, hasErrors, isFair, leftShift, makeFair, registerError, send, setPGroup`
`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 static final groovy.lang.Closure awaitClosure
  - private final groovy.lang.Closure copy
    
    Function converting the internal state during read to prevent internal state escape from the protected boundary of the agent
  - protected T data
    
    Holds the internal mutable state
  - private final java.util.Collection<groovy.lang.Closure> listeners
    
    Holds all listeners interested in state updates A listener should be a closure accepting the old and the new value in this order.
  - protected java.util.concurrent.locks.ReadWriteLock lock
    
    Allows reads not to wait in the message queue. Writes and reads are mutually separated by using write or read locks respectively.
  - private final java.util.Collection<groovy.lang.Closure> validators
    
    Holds all validators checking the agent's state A validator should be a closure accepting the old and the new value in this order.
- Constructor Detail
  - AgentBase(T data)
  - AgentBase(T data, groovy.lang.Closure copy)
    
    Creates a new Agent around the supplied modifiable object
    Parameters:
    data - The object to use for storing the internal state of the variable
    copy - A closure to use to create a copy of the internal state when sending the internal state out
- Method Detail
  - public void addListener(groovy.lang.Closure listener)
    
    Adds a listener interested in state updates A listener should be a closure accepting the old and the new value in this order plus optionally the agent reference as the first argument.
    Parameters:
    listener - The closure with two or three arguments
  - public void addValidator(groovy.lang.Closure validator)
    
    Adds a validator checking the agent's state A listener should be a closure accepting the old and the new value in this order plus optionally the agent reference as the first argument.
    Parameters:
    validator - The closure with two or three arguments
  - public final void await()
    
    Blocks until all messages in the queue prior to call to await() complete. Provides a means to synchronize with the Agent
    throws:
    InterruptedException If the thread gets interrupted while waiting for a value to be bound
  - private groovy.lang.Closure checkClosure(groovy.lang.Closure code)
    
    Only two-argument closures are allowed
    Returns:
    Either the original closure or a two-argument closure after currying the first argument of the passed-in closure to self
    Parameters:
    code - The passed-in closure
  - @java.lang.SuppressWarnings({"unchecked"}) public final T getInstantVal()
    
    A shorthand method for safe message-based retrieval of the internal state. Retrieves the internal state immediately by-passing the queue of tasks waiting to be processed.
    Returns:
    The current value of the actor's state
  - public final T getVal()
    
    A shorthand method for safe message-based retrieval of the internal state. The request to retrieve a value is put into the message queue, so will wait for all messages delivered earlier to complete.
    throws:
    InterruptedException If the thread gets interrupted while waiting for a value to be bound
    
    Returns:
    The value of the actor's state once all previously sent messages in the queue get processed
  - final void onMessage(org.codehaus.groovy.runtime.NullObject obj)
    
    Accepts a NullObject instance and sets the internal state to null
    Parameters:
    obj - The received message
  - final void onMessage(groovy.lang.Closure code)
    
    Accepts and invokes the closure
    Parameters:
    code - The received message
  - final void onMessage(T message)
    
    Other messages than closures are accepted as new values for the internal state
    Parameters:
    message - The received message
  - @java.lang.SuppressWarnings({"unchecked"}) public final T sendAndWait(groovy.lang.Closure message)
    
    Submits the closure waiting for the result
    throws:
    InterruptedException If the thread gets interrupted while waiting for a value to be bound
    
    Returns:
    The return value of the closure
    Parameters:
    message - The message/closure to send
  - @java.lang.SuppressWarnings({"unchecked", "CatchGenericClass"}) public final void updateValue(T newValue)
    
    Allows closures to set the new internal state as a whole Do not call this method directly from the outside. It is designed to be used from within the submitted closures.
    Parameters:
    newValue - The value to set the internal state to
  - public final void valAsync(groovy.lang.Closure callback)
    
    A shorthand method for safe asynchronous message-based retrieval of the internal state. The request to retrieve a value is put into the message queue, so will wait for all messages delivered earlier to complete.
    Parameters:
    callback - A closure to invoke with the internal state as a parameter

| Detail:
Field
Constructor
Method

[Java] Class AgentBase<T>

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final groovy.lang.Closure awaitClosure

private final groovy.lang.Closure copy

protected T data

private final java.util.Collection<groovy.lang.Closure> listeners

protected java.util.concurrent.locks.ReadWriteLock lock

private final java.util.Collection<groovy.lang.Closure> validators

Constructor Detail

AgentBase(T data)

AgentBase(T data, groovy.lang.Closure copy)

Method Detail

public void addListener(groovy.lang.Closure listener)

public void addValidator(groovy.lang.Closure validator)

public final void await()

private groovy.lang.Closure checkClosure(groovy.lang.Closure code)

@java.lang.SuppressWarnings({"unchecked"}) public final T getInstantVal()

public final T getVal()

final void onMessage(org.codehaus.groovy.runtime.NullObject obj)

final void onMessage(groovy.lang.Closure code)

final void onMessage(T message)

@java.lang.SuppressWarnings({"unchecked"}) public final T sendAndWait(groovy.lang.Closure message)

@java.lang.SuppressWarnings({"unchecked", "CatchGenericClass"}) public final void updateValue(T newValue)

public final void valAsync(groovy.lang.Closure callback)