edu.iu.dsc.tws.api.comms

Class BaseOperation

java.lang.Object

edu.iu.dsc.tws.api.comms.BaseOperation

Direct Known Subclasses:

BAllGather, BAllReduce, BBroadcast, BDirect, BGather, BJoin, BKeyedGather, BKeyedPartition, BKeyedReduce, BPartition, BReduce, BTPartition, SAllGather, SAllReduce, SBroadCast, SDirect, SGather, SKeyedGather, SKeyedPartition, SKeyedReduce, SPartition, SReduce, STPartition

public abstract class BaseOperation
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected TWSChannel	channel THe underlying channel
protected DataFlowOperation	op The actual operation

Constructor Summary

Constructors

Constructor and Description
BaseOperation(Communicator comm, boolean stream, java.lang.String opName) Create the base operation

Method Summary

Modifier and Type	Method and Description
void	close()
void	finish(int src) Indicate the end of the communication
boolean	isComplete() Weather we have messages pending
boolean	progress() Progress the operation, if not called, messages will not be processed
boolean	progressChannel() Progress the channel and the operation
void	reset() Clean the operation, this doesn't close it
boolean	sendBarrier(int src, byte[] barrierId)
void	waitForCompletion() Wait for the operation to complete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

op

protected DataFlowOperation op

The actual operation

channel

protected TWSChannel channel

THe underlying channel

Constructor Detail

BaseOperation

public BaseOperation(Communicator comm,
                     boolean stream,
                     java.lang.String opName)

Create the base operation

Method Detail

isComplete

public boolean isComplete()

Weather we have messages pending

Returns:

true if there are messages pending

finish

public void finish(int src)

Indicate the end of the communication

Parameters:

src - the source that is ending

progress

public boolean progress()

Progress the operation, if not called, messages will not be processed

Returns:

true if further progress is needed

close

public void close()

reset

public void reset()

Clean the operation, this doesn't close it

progressChannel

public boolean progressChannel()

Progress the channel and the operation

Returns:

true if further progress is required

sendBarrier

public boolean sendBarrier(int src,
                           byte[] barrierId)

waitForCompletion

public void waitForCompletion()

Wait for the operation to complete