HjPhaser (hjlib-cooperative 0.1.5-SNAPSHOT API)

All Known Subinterfaces:

InternalPhaser

All Known Implementing Classes:

PhaserImpl
```
public interface HjPhaser
```
Phasers are a new coordination construct that unifies collective and point-to-point synchronizations. Phasers have two safety properties: deadlock-freedom and phase- ordering.
Phasers enable integration of producer-consumer with barrier synchronization. An activity has the option of registering with a phaser in signal-only mode or wait-only mode for producer-consumer synchronization, in addition to signal-wait mode for barrier synchronization.
At any point in time, an activity can be registered in one of four modes with respect to a phaser: signal-wait-next, signal-wait, signal-only, or wait-only. The mode defines the capabilities of the activity with respect to the phaser.
Details: Phasers: a Unified Deadlock-Free Construct for Collective and Point-to-point Synchronization. Jun Shirako, David Peixotto, Vivek Sarkar, William Scherer. Proceedings of the 2008 ACM International Conference on Supercomputing (ICS), June 2008.

Author:

Shams Imam (shams@rice.edu)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`doNext()` The next operation has the effect of advancing each phaser on which the task is registered to its next phase, thereby synchronizing all activities registered on the same phase.
`void`	`doWait()` Blocks until all phasers that this activity is registered with have called continue (or next since next implies continue on all registered phasers).
`default void`	`drop()` An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser.
`void`	`drop(boolean activityEndSignal)` An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser.
`HjPhaserMode`	`getPhaserMode()` Returns the registration mode of the phaser was created with.
`int`	`getSigPhase()` Returns the signal phase number of this phaser in the currently executing task.
`int`	`getWaitPhase()` Returns the wait phase number of this phaser in the currently executing task.
`HjPhaserPair`	`inMode(HjPhaserMode phaserMode)` Return a `HjPhaserPair` with the phaser in the specified registration mode.
`void`	`signal()` An activity calls this method to tell the phaser that is done with whatever it intended to do during this phase of the phaser.

- Method Detail
  - inMode
```
HjPhaserPair inMode(HjPhaserMode phaserMode)
```
    Return a HjPhaserPair with the phaser in the specified registration mode.
    
    Parameters:
    
    phaserMode - The phaser registration mode.
    
    Returns:
    
    a HjPhaserPair in a specified mode
  - getPhaserMode
```
HjPhaserMode getPhaserMode()
```
    Returns the registration mode of the phaser was created with.
    
    Returns:
    
    the registration mode of the phaser was created with.
  - signal
```
void signal()
```
    An activity calls this method to tell the phaser that is done with whatever it intended to do during this phase of the phaser. The activity will not post any other statement for execution in this phase of the phaser.
  - doWait
```
void doWait()
     throws SuspendableException
```
    Blocks until all phasers that this activity is registered with have called continue (or next since next implies continue on all registered phasers).
    This method is used internally by the Runtime and should not be visible for clients. Clients should use Runtime.doNext().
    
    Throws:
    
    SuspendableException
  - doNext
```
void doNext()
     throws SuspendableException
```
    The next operation has the effect of advancing each phaser on which the task is registered to its next phase, thereby synchronizing all activities registered on the same phase.
    next is equivalent to a signal followed by wait.
    
    Throws:
    
    SuspendableException
  - drop
```
void drop(boolean activityEndSignal)
```
    An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser. It will no longer call now or resume on this phaser. The activity is considered de-registered from the phaser after this method returns.
    
    Parameters:
    
    activityEndSignal - true if drop() was called from deregister() in activityEnd event
  - drop
```
default void drop()
```
    An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser. It will no longer call now or resume on this phaser. The activity is considered de-registered from the phaser after this method returns.
    Default method for drop(boolean activityEndSignal)
  - getSigPhase
```
int getSigPhase()
```
    Returns the signal phase number of this phaser in the currently executing task.
    
    Returns:
    
    the signal phase number of this phaser in the currently executing task
  - getWaitPhase
```
int getWaitPhase()
```
    Returns the wait phase number of this phaser in the currently executing task.
    
    Returns:
    
    the wait phase number of this phaser in the currently executing task

Interface HjPhaser

Method Summary

Method Detail

inMode

getPhaserMode

signal

doWait

doNext

drop

drop

getSigPhase

getWaitPhase