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

Class KGatherStreamingReceiver

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

KGatherStreamingFinalReceiver, KGatherStreamingPartialReceiver

public abstract class KGatherStreamingReceiver
extends KeyedReceiver

Abstract class that is extended by keyed reduce batch receivers

Field Summary

Fields

Modifier and Type	Field and Description
protected int	localWindowCount variable used to keep track of the current local window count.
protected int	windowSize Streaming messages are only kept until the window size is met.

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
KGatherStreamingReceiver()

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	offerMessage(int target, java.lang.Object object) saves the given message (or messages if the object is a list) into the messages data structure if possible and rejects the message if the whole message cannot be added to the messages data structure.
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, 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

Field Detail

windowSize

protected int windowSize

Streaming messages are only kept until the window size is met. by default the window size is 1, so all messages are forwarded as they arrive.

localWindowCount

protected int localWindowCount

variable used to keep track of the current local window count. This value is always reset to 0 after it reaches the windowSize

Constructor Detail

KGatherStreamingReceiver

public KGatherStreamingReceiver()

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

offerMessage

protected boolean offerMessage(int target,
                               java.lang.Object object)

saves the given message (or messages if the object is a list) into the messages data structure if possible and rejects the message if the whole message cannot be added to the messages data structure.

Overrides:

offerMessage in class KeyedReceiver

Parameters:

target - target for which the messages are to be added

object - the message/messages to be added

Returns:

true if the message was added or false otherwise

sendToTarget

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

Description copied from class: KeyedReceiver

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