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

Class TargetReceiver

java.lang.Object

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

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

TargetFinalReceiver, TargetPartialReceiver

public abstract class TargetReceiver
extends java.lang.Object
implements MessageReceiver

Field Summary

Fields

Modifier and Type	Field and Description
protected int	destination The destination
protected long	groupingSize The message grouping size
protected int	highWaterMark High water mark to keep track of objects
protected java.util.concurrent.locks.Lock	lock The lock
protected <any>	messages Lets keep track of the messages, we need to keep track of the messages for each target and source, Map<target, Queue<messages>>
protected DataFlowOperation	operation The operations
protected int	representSource The source task connected to this partial receiver
protected SyncState	syncState The sync state
protected int[]	targets The targets
protected java.util.Set<java.lang.Integer>	thisDestinations The destinations we are sending messages to
protected java.util.Set<java.lang.Integer>	thisSources Sources we are expecting messages from
protected int	workerId The worker id this receiver is in

Constructor Summary

Constructors

Constructor and Description
TargetReceiver()

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 abstract void	addSyncMessage(int source, int target) Add a sync message
protected abstract void	addSyncMessageBarrier(int source, int target, byte[] barrier) Add a sync message
protected abstract boolean	canAcceptMessage(int source, int target) Check weather we can accept a message
protected void	clearTarget(int target) Clear all the buffers for the target, to ready for the next
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 abstract boolean	isFilledToSend(int target) Return true if we are filled to send
protected abstract void	merge(int dest, java.util.List<java.lang.Object> dests) Swap the messages to the ready queue
boolean	onMessage(int source, int path, int target, int flags, java.lang.Object object) The actual message callback
protected abstract boolean	onSyncEvent(int target, byte[] value) This method is called when there is a sync event on the operation
protected abstract boolean	sendToTarget(int source, int target) Send the values to a target

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, isComplete, onMessage, progress

Field Detail

messages

protected <any> messages

Lets keep track of the messages, we need to keep track of the messages for each target and source, Map<target, Queue<messages>>

workerId

protected int workerId

The worker id this receiver is in

operation

protected DataFlowOperation operation

The operations

destination

protected int destination

The destination

representSource

protected int representSource

The source task connected to this partial receiver

highWaterMark

protected int highWaterMark

High water mark to keep track of objects

lock

protected java.util.concurrent.locks.Lock lock

The lock

thisSources

protected java.util.Set<java.lang.Integer> thisSources

Sources we are expecting messages from

thisDestinations

protected java.util.Set<java.lang.Integer> thisDestinations

The destinations we are sending messages to

syncState

protected SyncState syncState

The sync state

groupingSize

protected long groupingSize

The message grouping size

targets

protected int[] targets

The targets

Constructor Detail

TargetReceiver

public TargetReceiver()

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

expectedIds - expected task ids

onMessage

public boolean onMessage(int source,
                         int path,
                         int target,
                         int flags,
                         java.lang.Object object)

Description copied from interface: MessageReceiver

The actual message callback

Specified by:

onMessage in interface MessageReceiver

Parameters:

source - the source task

path - the path that is taken by the message, that is intermediate targets

target - the target of this receiver

flags - the communication flags

object - the actual message

Returns:

true if the message is accepted

addMessage

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

addSyncMessage

protected abstract void addSyncMessage(int source,
                                       int target)

Add a sync message

Parameters:

source - source

target - target

addSyncMessageBarrier

protected abstract void addSyncMessageBarrier(int source,
                                              int target,
                                              byte[] barrier)

Add a sync message

Parameters:

source - source

target - target

barrier - the barrier message

canAcceptMessage

protected abstract boolean canAcceptMessage(int source,
                                            int target)

Check weather we can accept a message

Parameters:

source - source

target - target

merge

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

Swap the messages to the ready queue

Parameters:

dest - the target

dests - message queue to switch to ready

clearTarget

protected void clearTarget(int target)

Clear all the buffers for the target, to ready for the next

Parameters:

target - target

sendToTarget

protected abstract boolean sendToTarget(int source,
                                        int target)

Send the values to a target

Parameters:

source - the sources

target - the target

Returns:

true if all the values are sent successfully

onSyncEvent

protected abstract boolean onSyncEvent(int target,
                                       byte[] value)

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

Parameters:

target - the target to which the sync event belong

value - the byte value, can be null

isFilledToSend

protected abstract boolean isFilledToSend(int target)

Return true if we are filled to send

Returns:

true if we are filled enough to send