SyncDataflowVariable (org.codehaus.gpars)

groovyx.gpars.dataflow.SyncDataflowVariable

A synchronous variant of DataflowVariable, which blocks the writer as well as the readers. The synchronous variable ensures a specified number of readers must ask for a value before the writer as well as the readers can continue.
Authors:
Vaclav Pech

Field Summary

Fields
Modifiers	Name	Description
`private static java.lang.String`	`ERROR_READING_A_SYNCHRONOUS_CHANNEL`
`private ResizeableCountDownLatch`	`parties`

Inherited fields
Fields inherited from class	Fields
`class DataflowVariable`	`serialVersionUID`
`class DataflowExpression`	`ATTACHMENT, A_DATAFLOW_VARIABLE_CAN_ONLY_BE_ASSIGNED_ONCE_ONLY_RE_ASSIGNMENTS_TO_AN_EQUAL_VALUE_ARE_ALLOWED, CANNOT_FIRE_BIND_ERRORS_THE_THREAD_HAS_BEEN_INTERRUPTED, RESULT, S_INITIALIZED, S_INITIALIZING, S_NOT_INITIALIZED, dummyWaitingThread, error, eventManager, metaClass, serialVersionUID, state, stateUpdater, value, waiting, waitingUpdater`
`class WithSerialId`	`serialHandle, serialVersionUID`

Constructor Summary

Constructors
Constructor and description
`SyncDataflowVariable ()` Creates a new variable, which will never block writers.
`SyncDataflowVariable (int parties)` Creates a new variable blocking the specified number of readers.

Methods Summary

Methods
Type	Name and description
`private void`	`awaitParties()`
`boolean`	`awaitingParties()` Reports whether the variable is still waiting for parties to arrive for the rendezvous.
`DataflowReadChannel<V>`	`chainWith(PGroup group, groovy.lang.Closure<V> closure)`
`void`	`decrementParties()` Decreases the number of parties required to perform data exchange by one
`protected void`	`doBindImpl(T value)`
`T`	`getVal()` Reads the value of the variable.
`T`	`getVal(long timeout, java.util.concurrent.TimeUnit units)` Reads the value of the variable.
`void`	`incrementParties()` Increases the number of parties required to perform data exchange by one.
`DataflowReadChannel<V>`	`merge(PGroup group, java.util.List<DataflowReadChannel<java.lang.Object>> others, groovy.lang.Closure<V> closure)`
`private void`	`readerIsReady()`
`private boolean`	`readerIsReady(long timeout)`
`protected void`	`scheduleCallback(java.lang.Object attachment, MessageStream callback)`
`boolean`	`shouldThrowTimeout()`
`DataflowReadChannel<T>`	`tap(PGroup group, DataflowWriteChannel<T> target)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DataflowVariable`	`bindDFV, get, get, getError, getRemoteClass, isError, leftShift, leftShift, shouldThrowTimeout, then, then, then, touch`
`class DataflowExpression`	DataflowExpression, binaryChoice, binaryChoice, binaryChoice, binaryChoice, binaryChoice, binaryChoice, bind, bindError, bindSafely, bindUnique, chainWith, chainWith, chainWith, chainWith, chainWith, chainWith, choice, choice, choice, choice, choice, choice, createEventManager, doBind, doBindImpl, doBindRemote, doThenForkAndJoin, evaluate, filter, filter, filter, filter, filter, filter, fireBindError, fireBindError, fireOnMessage, getBindErrorManager, getEventManager, getMetaClass, getProperty, getVal, getVal, getValAsync, getValAsync, handleInterruption, into, into, into, into, into, into, invokeMethod, isBound, join, join, length, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, notifyRemote, or, or, poll, rightShift, scheduleCallback, separate, separate, separate, separate, separate, separate, setMetaClass, setProperty, split, split, split, split, split, split, split, split, split, split, split, split, subscribe, subscribe, tap, tap, tap, tap, tap, tap, then, then, then, thenForkAndJoin, thenForkAndJoin, thenForkAndJoin, toString, transform, whenBound, whenBound, whenBound, whenBound, wheneverBound, wheneverBound
`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 java.lang.String ERROR_READING_A_SYNCHRONOUS_CHANNEL
  - private final ResizeableCountDownLatch parties
- Constructor Detail
  - public SyncDataflowVariable()
    
    Creates a new variable, which will never block writers.
  - public SyncDataflowVariable(int parties)
    
    Creates a new variable blocking the specified number of readers.
    Parameters:
    parties - Number of readers that have to match a writer before the message gets transferred
- Method Detail
  - private void awaitParties()
  - public boolean awaitingParties()
    
    Reports whether the variable is still waiting for parties to arrive for the rendezvous.
    Returns:
    True if not all parties have shown yet
  - @java.lang.Override public DataflowReadChannel<V> chainWith(PGroup group, groovy.lang.Closure<V> closure)
  - public void decrementParties()
    
    Decreases the number of parties required to perform data exchange by one
  - @java.lang.Override protected void doBindImpl(T value)
  - @java.lang.Override public T getVal()
    
    Reads the value of the variable. Blocks, if the value has not been assigned yet.
    throws:
    InterruptedException If the current thread gets interrupted while waiting for the variable to be bound
    
    Returns:
    The actual value
  - @java.lang.Override public T getVal(long timeout, java.util.concurrent.TimeUnit units)
    
    Reads the value of the variable. Blocks up to given timeout, if the value has not been assigned yet.
    throws:
    InterruptedException If the current thread gets interrupted while waiting for the variable to be bound
    
    Returns:
    The actual value
    Parameters:
    timeout - The timeout value
    units - Units for the timeout
  - public void incrementParties()
    
    Increases the number of parties required to perform data exchange by one.
  - @java.lang.Override public DataflowReadChannel<V> merge(PGroup group, java.util.List<DataflowReadChannel<java.lang.Object>> others, groovy.lang.Closure<V> closure)
  - private void readerIsReady()
  - private boolean readerIsReady(long timeout)
  - @java.lang.Override protected void scheduleCallback(java.lang.Object attachment, MessageStream callback)
  - @java.lang.Override boolean shouldThrowTimeout()
  - @java.lang.Override public DataflowReadChannel<T> tap(PGroup group, DataflowWriteChannel<T> target)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class SyncDataflowVariable<T>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final java.lang.String ERROR_READING_A_SYNCHRONOUS_CHANNEL

private final ResizeableCountDownLatch parties

Constructor Detail

public SyncDataflowVariable()

public SyncDataflowVariable(int parties)

Method Detail

private void awaitParties()

public boolean awaitingParties()

@java.lang.Override public DataflowReadChannel<V> chainWith(PGroup group, groovy.lang.Closure<V> closure)

public void decrementParties()

@java.lang.Override protected void doBindImpl(T value)

@java.lang.Override public T getVal()

@java.lang.Override public T getVal(long timeout, java.util.concurrent.TimeUnit units)

public void incrementParties()

@java.lang.Override public DataflowReadChannel<V> merge(PGroup group, java.util.List<DataflowReadChannel<java.lang.Object>> others, groovy.lang.Closure<V> closure)

private void readerIsReady()

private boolean readerIsReady(long timeout)

@java.lang.Override protected void scheduleCallback(java.lang.Object attachment, MessageStream callback)

@java.lang.Override boolean shouldThrowTimeout()

@java.lang.Override public DataflowReadChannel<T> tap(PGroup group, DataflowWriteChannel<T> target)