ImmediateCountingPoisonPill (org.codehaus.gpars)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

groovyx.gpars.dataflow.operator.ImmediateCountingPoisonPill

Represents an immediate PoisonPill that counts stopped operators and can be used to wait for all the operators to terminate.
Authors:
Vaclav Pech

Field Summary

Fields
Modifiers	Name	Description
`private PoisonTrackCounter`	`poisonTrackCounter`

Inherited fields
Fields inherited from class	Fields
`class PoisonPill`	`immediate, immediateInstance, ourInstance`

Constructor Summary

Constructors
Constructor and description
`ImmediateCountingPoisonPill (int count)` Creates an immediate instance that could be used to stop operators in a network.

Methods Summary

Methods
Type	Name and description
`void`	`countDown()`
`Promise<java.lang.Boolean>`	`getTermination()` Retrieves the promise for termination
`void`	`join()` Blocks until the number of terminated operators reaches the number specified in the constructor
`void`	`join(long timeout, java.util.concurrent.TimeUnit unit)` Blocks until the number of terminated operators reaches the number specified in the constructor

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class PoisonPill`	`countDown, getImmediateInstance, getInstance, isImmediate`
`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 final PoisonTrackCounter poisonTrackCounter
- Constructor Detail
  - public ImmediateCountingPoisonPill(int count)
    
    Creates an immediate instance that could be used to stop operators in a network.
    Parameters:
    count - The number of operators that need to be stopped before the join() method returns.
- Method Detail
  - @java.lang.Override void countDown()
  - public Promise<java.lang.Boolean> getTermination()
    
    Retrieves the promise for termination
    Returns:
    A Promise instance that will be bound when all the requested dataflow processors have been terminated
  - public void join()
    
    Blocks until the number of terminated operators reaches the number specified in the constructor
    throws:
    InterruptedException If the current thread gets interrupted during the blocking
  - public void join(long timeout, java.util.concurrent.TimeUnit unit)
    
    Blocks until the number of terminated operators reaches the number specified in the constructor
    throws:
    InterruptedException If the current thread gets interrupted during the blocking
    
    Parameters:
    timeout - the maximum time to wait
    unit - the time unit of the timeout argument

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Copyright © 2008–2014 Václav Pech. All Rights Reserved.