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

Class TargetPartialReceiver

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

PartitionPartialReceiver

public class TargetPartialReceiver
extends TargetReceiver

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,byte[]>	barriers The barriers for each source
protected <any>	sourceStates Keep state
protected boolean	stateCleared State is cleared
protected <any>	syncSent Keep track what are the targets we've sent syncs to

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

Method Summary

Modifier and Type	Method and Description
protected void	addMessage(int target, java.util.List<java.lang.Object> msgQueue, java.lang.Object value)
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
boolean	isComplete() Weather we are complete a set of messages
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
protected boolean	onSyncEvent(int target, byte[] value) This method is called when there is a sync event on the operation
boolean	progress() This method will be called by the communicationProgress
protected boolean	sendToTarget(int source, int target) This gets called with a represented source
boolean	sync() Handle the sync

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

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

sourceStates

protected <any> sourceStates

Keep state

syncSent

protected <any> syncSent

Keep track what are the targets we've sent syncs to

barriers

protected java.util.Map<java.lang.Integer,byte[]> barriers

The barriers for each source

stateCleared

protected boolean stateCleared

State is cleared

Constructor Detail

TargetPartialReceiver

public TargetPartialReceiver()

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

merge

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

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)

This gets called with a represented source

Specified by:

sendToTarget in class TargetReceiver

Parameters:

source - the sources the represented source

target - the target the true target

Returns:

true if send if successful or nothing to send

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

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

addMessage

protected void addMessage(int target,
                          java.util.List<java.lang.Object> msgQueue,
                          java.lang.Object value)

Overrides:

addMessage in class TargetReceiver

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

sync

public boolean sync()

Handle the sync

Returns:

true if everything is synced

clean

public void clean()

Description copied from interface: MessageReceiver

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

onSyncEvent

protected 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