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

Class KGatherBatchFinalReceiver

java.lang.Object

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

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

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

All Implemented Interfaces:

MessageReceiver

public class KGatherBatchFinalReceiver
extends TargetFinalReceiver

Final receiver for keyed gather

Field Summary

Fields

Modifier and Type	Field and Description
protected <any>	gathered The reduced values for each target and key

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

barriers, stateCleared, syncReceived, targetStates

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
KGatherBatchFinalReceiver(BulkReceiver receiver, boolean groupByKey) Create a receiver without sorting
KGatherBatchFinalReceiver(BulkReceiver receiver, boolean groupByKey, java.util.Comparator<java.lang.Object> keyComparator) Create a receiver with sorting

Method Summary

Modifier and Type	Method and Description
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)
protected boolean	isFilledToSend(int target) Return true if we are filled to send
protected void	merge(int dest, java.util.List<java.lang.Object> dests) Swap the messages to the ready queue
boolean	onSyncEvent(int target, byte[] value) This method is called when there is a sync event on the operation
protected boolean	sendToTarget(int source, int target) Send the values to a target

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

addSyncMessage, addSyncMessageBarrier, canAcceptMessage, clean, isComplete, progress, sync

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

addMessage, clearTarget, onMessage

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

gathered

protected <any> gathered

The reduced values for each target and key

Constructor Detail

KGatherBatchFinalReceiver

public KGatherBatchFinalReceiver(BulkReceiver receiver,
                                 boolean groupByKey)

Create a receiver without sorting

Parameters:

receiver - the receiver

groupByKey - weather to group return values according to key

KGatherBatchFinalReceiver

public KGatherBatchFinalReceiver(BulkReceiver receiver,
                                 boolean groupByKey,
                                 java.util.Comparator<java.lang.Object> keyComparator)

Create a receiver with sorting

Parameters:

receiver - the receiver

groupByKey - weather to group return values according to key

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 TargetFinalReceiver

expectedIds - expected task ids

merge

protected void merge(int dest,
                     java.util.List<java.lang.Object> dests)

Description copied from class: TargetReceiver

Swap the messages to the ready queue

Specified by:

merge in class TargetReceiver

Parameters:

dest - the target

dests - message queue to switch to ready

sendToTarget

protected boolean sendToTarget(int source,
                               int target)

Description copied from class: TargetReceiver

Send the values to a target

Specified by:

sendToTarget in class TargetReceiver

Parameters:

source - the sources

target - the target

Returns:

true if all the values are sent successfully

isAllEmpty

protected boolean isAllEmpty(int target)

Specified by:

isAllEmpty in class TargetFinalReceiver

isFilledToSend

protected boolean isFilledToSend(int target)

Description copied from class: TargetReceiver

Return true if we are filled to send

Specified by:

isFilledToSend in class TargetReceiver

Returns:

true if we are filled enough to send

onSyncEvent

public boolean onSyncEvent(int target,
                           byte[] value)

Description copied from class: TargetReceiver

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

Specified by:

onSyncEvent in class TargetReceiver

Parameters:

target - the target to which the sync event belong

value - the byte value, can be null