edu.iu.dsc.tws.comms.dfw.io

Class TargetFinalReceiver

java.lang.Object

edu.iu.dsc.tws.comms.dfw.io.TargetReceiver

edu.iu.dsc.tws.comms.dfw.io.TargetFinalReceiver

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

BcastBatchFinalReceiver, BcastGatherBatchReceiver, BcastGatheStreamingReceiver, BcastStreamingFinalReceiver, DirectBatchFinalReceiver, DirectStreamingFinalReceiver, JoinPartitionBatchFinalReceiver, KGatherBatchFinalReceiver, KReduceBatchFinalReceiver, PartitionBatchFinalReceiver, PartitionStreamingFinalReceiver

public abstract class TargetFinalReceiver
extends TargetReceiver

Field Summary

Fields

Modifier and Type	Field and Description
protected <any>	barriers The barriers for each target
protected boolean	stateCleared State is cleared
protected java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>>	syncReceived Keep weather we have received a sync from a source
protected <any>	targetStates Keep state about the targets

Fields inherited from class edu.iu.dsc.tws.comms.dfw.io.TargetReceiver

destination, groupingSize, highWaterMark, lock, messages, operation, representSource, syncState, targets, thisDestinations, thisSources, workerId

Constructor Summary

Constructors

Constructor and Description
TargetFinalReceiver()

Method Summary

Modifier and Type	Method and Description
protected void	addSyncMessage(int source, int target) Add a sync message
protected void	addSyncMessageBarrier(int source, int target, byte[] barrier) Add a sync message
protected boolean	canAcceptMessage(int source, int target) Check weather we can accept a message
void	clean() Clean any state associated with the receiver and go to initial state
void	init(Config cfg, DataFlowOperation op, java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>> expectedIds) Initialize the message receiver with tasks from which messages are expected For each sub edge in graph, for each path, gives the expected task ids
protected abstract boolean	isAllEmpty(int target)
boolean	isComplete() Weather we are complete a set of messages
boolean	progress() This method will be called by the communicationProgress
protected boolean	sync(int target)

Methods inherited from class edu.iu.dsc.tws.comms.dfw.io.TargetReceiver

addMessage, clearTarget, isFilledToSend, merge, onMessage, onSyncEvent, sendToTarget

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.dsc.tws.api.comms.messaging.MessageReceiver

close, onMessage

Field Detail

syncReceived

protected java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> syncReceived

Keep weather we have received a sync from a source

targetStates

protected <any> targetStates

Keep state about the targets

barriers

protected <any> barriers

The barriers for each target

stateCleared

protected boolean stateCleared

State is cleared

Constructor Detail

TargetFinalReceiver

public TargetFinalReceiver()

Method Detail

init

public void init(Config cfg,
                 DataFlowOperation op,
                 java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>> expectedIds)

Description copied from interface: MessageReceiver

Initialize the message receiver with tasks from which messages are expected For each sub edge in graph, for each path, gives the expected task ids

target -> source tasks

Specified by:

init in interface MessageReceiver

Overrides:

init in class TargetReceiver

expectedIds - expected task ids

addSyncMessage

protected void addSyncMessage(int source,
                              int target)

Description copied from class: TargetReceiver

Add a sync message

Specified by:

addSyncMessage in class TargetReceiver

Parameters:

source - source

target - target

addSyncMessageBarrier

protected void addSyncMessageBarrier(int source,
                                     int target,
                                     byte[] barrier)

Description copied from class: TargetReceiver

Add a sync message

Specified by:

addSyncMessageBarrier in class TargetReceiver

Parameters:

source - source

target - target

barrier - the barrier message

canAcceptMessage

protected boolean canAcceptMessage(int source,
                                   int target)

Description copied from class: TargetReceiver

Check weather we can accept a message

Specified by:

canAcceptMessage in class TargetReceiver

Parameters:

source - source

target - target

progress

public boolean progress()

Description copied from interface: MessageReceiver

This method will be called by the communicationProgress

Returns:

true if needs further communicationProgress

isComplete

public boolean isComplete()

Description copied from interface: MessageReceiver

Weather we are complete a set of messages

Returns:

true if a round is complete with syncs

isAllEmpty

protected abstract boolean isAllEmpty(int target)

sync

protected boolean sync(int target)

clean

public void clean()

Description copied from interface: MessageReceiver

Clean any state associated with the receiver and go to initial state