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

Class BaseGatherBatchReceiver

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

AllGatherBatchFinalReceiver, GatherBatchFinalReceiver, GatherBatchPartialReceiver

public abstract class BaseGatherBatchReceiver
extends SourceReceiver

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>>	gatheredValuesMap
protected static java.util.logging.Logger	LOG

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

barriers, destination, isSyncSent, messages, operation, sendPendingMax, sourcesOfTarget, syncReceived, syncState, targetStates, workerId

Constructor Summary

Constructors

Constructor and Description
BaseGatherBatchReceiver()

Method Summary

Modifier and Type	Method and Description
protected boolean	aggregate(int target, boolean sync, boolean allValuesFound) Aggregate values from sources for a target, assumes every source has a value
protected abstract boolean	handleMessage(int task, java.lang.Object message, int flags, int dest)
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 boolean	isAllEmpty(int target) Check weather all the other information is flushed
protected void	onSyncEvent(int target, byte[] value) This method is called when there is a sync event on the operation
protected boolean	sendToTarget(int target, boolean sync) Send the values to a target

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

allQueuesEmpty, allSyncsPresent, clean, isComplete, isFilledToSend, onFinish, onMessage, progress, sendSyncForward

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

LOG

protected static final java.util.logging.Logger LOG

gatheredValuesMap

protected java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>> gatheredValuesMap

Constructor Detail

BaseGatherBatchReceiver

public BaseGatherBatchReceiver()

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 SourceReceiver

expectedIds - expected task ids

sendToTarget

protected boolean sendToTarget(int target,
                               boolean sync)

Description copied from class: SourceReceiver

Send the values to a target

Specified by:

sendToTarget in class SourceReceiver

Parameters:

target - the target

Returns:

true if all the values are sent successfully

aggregate

protected boolean aggregate(int target,
                            boolean sync,
                            boolean allValuesFound)

Description copied from class: SourceReceiver

Aggregate values from sources for a target, assumes every source has a value

Specified by:

aggregate in class SourceReceiver

Parameters:

target - target

sync - true if all the syncs are present

Returns:

true if there are no more elements to aggregate

isAllEmpty

protected boolean isAllEmpty(int target)

Description copied from class: SourceReceiver

Check weather all the other information is flushed

Specified by:

isAllEmpty in class SourceReceiver

Parameters:

target - target

Returns:

true if there is nothing to process

handleMessage

protected abstract boolean handleMessage(int task,
                                         java.lang.Object message,
                                         int flags,
                                         int dest)

onSyncEvent

protected void onSyncEvent(int target,
                           byte[] value)

Description copied from class: SourceReceiver

This method is called when there is a sync event on the operation

Specified by:

onSyncEvent in class SourceReceiver

Parameters:

target - the target to which the sync event belong

value - the byte value, can be null