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

Class KGatherBatchPartialReceiver

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver

public class KGatherBatchPartialReceiver
extends KeyedReceiver

Abstract class that is extended by keyed reduce batch receivers

Field Summary

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

batchDone, dataFlowOperation, destination, executor, finishedSources, isEmptySent, isFinalBatchReceiver, keyLimit, limitPerKey, messages, representSource, representSourceSet, sendQueue, thisSources

Constructor Summary

Constructors

Constructor and Description
KGatherBatchPartialReceiver(int dest, int limitPerKey)

Method Summary

Modifier and Type	Method and Description
protected boolean	isAllQueuesEmpty(java.util.Queue<java.lang.Object> targetSendQueue) checks if the queue structures used to send data is empty.
protected boolean	sendToTarget(boolean needsFurtherProgress, boolean sourcesFinished, int target, java.util.Queue<java.lang.Object> targetSendQueue) Called from the progress method to perform the communication calls to send the queued messages

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

checkIfEmptyIsSent, finishProgress, init, isComplete, isSourcesFinished, moveMessagesToSendQueue, moveMessageToSendQueue, offerMessage, onFinish, onMessage, progress

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

clean, close, onMessage

Constructor Detail

KGatherBatchPartialReceiver

public KGatherBatchPartialReceiver(int dest,
                                   int limitPerKey)

Method Detail

isAllQueuesEmpty

protected boolean isAllQueuesEmpty(java.util.Queue<java.lang.Object> targetSendQueue)

checks if the queue structures used to send data is empty. If Additional data structures are used this method needs to be overwritten to include them. This method overrides the default implementation and also checks to make sure the sendList is also empty

Overrides:

isAllQueuesEmpty in class KeyedReceiver

Parameters:

targetSendQueue - message queue for the current target

Returns:

true if all the related queues and structures are empty

sendToTarget

protected boolean sendToTarget(boolean needsFurtherProgress,
                               boolean sourcesFinished,
                               int target,
                               java.util.Queue<java.lang.Object> targetSendQueue)

Called from the progress method to perform the communication calls to send the queued messages

Overrides:

sendToTarget in class KeyedReceiver

Parameters:

needsFurtherProgress - current state of needsFurtherProgress value

sourcesFinished - specifies if the sources have completed

target - the target(which is a source in this instance) from which the messages are sent

targetSendQueue - the data structure that contains all the message data

Returns:

true if further progress is needed or false otherwise