edu.iu.dsc.tws.comms.dfw

Class TreeBroadcast

java.lang.Object

edu.iu.dsc.tws.comms.dfw.TreeBroadcast

All Implemented Interfaces:

ChannelReceiver, DataFlowOperation

public class TreeBroadcast
extends java.lang.Object
implements DataFlowOperation, ChannelReceiver

Constructor Summary

Constructors

Constructor and Description
TreeBroadcast(TWSChannel channel, int src, java.util.Set<java.lang.Integer> dests, MessageReceiver finalRcvr, MessageSchema messageSchema)
TreeBroadcast(TWSChannel channel, int src, java.util.Set<java.lang.Integer> dests, MessageReceiver finalRcvr, MessageType keyType, MessageType dataType, MessageSchema messageSchema)

Method Summary

Modifier and Type	Method and Description
void	close() Close the operation
void	finish(int target) If this is a larger transfer of dataflow style, we need to finish
LogicalPlan	getLogicalPlan() Task plan associated with this operation
java.util.Set<java.lang.Integer>	getSources() Get the sources of the operation
java.util.Set<java.lang.Integer>	getTargets() Get targets of operation
java.lang.String	getUniqueId() Returns a unique id for this operation.
boolean	handleReceivedChannelMessage(ChannelMessage currentMessage) Handle a partially received buffers
void	init(Config cfg, MessageType dType, LogicalPlan tPlan, int ed) Initialize
void	init(Config cfg, MessageType dType, MessageType recvDType, LogicalPlan tPlan, int ed)
void	init(Config cfg, MessageType dType, MessageType recvDType, MessageType kType, MessageType recvKType, LogicalPlan tPlan, int ed) Initialize
boolean	isComplete() Weather the operation doesn't have any pending sends or receives
boolean	isDelegateComplete()
boolean	progress() Progress the pending dataflow operations
java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>>	receiveExpectedTaskIds()
boolean	receiveMessage(MessageHeader h, java.lang.Object o) Receive a fully built message
boolean	receiveSendInternally(int src, int target, int path, int flags, java.lang.Object message) For partial receives the path and
protected java.util.Set<java.lang.Integer>	receivingExecutors()
void	reset() Reset and get the operation to initial state
boolean	send(int src, java.lang.Object message, int flags) Send a send message, this call will work asynchronously
boolean	send(int src, java.lang.Object message, int flags, int target) Send the message on a specific path
boolean	sendPartial(int src, java.lang.Object message, int flags) Use this to inject partial results in a distributed dataflow operation
boolean	sendPartial(int src, java.lang.Object message, int flags, int target) Send partial message on a specific path

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.DataFlowOperation

getDataType, getKeyType, getReceiveDataType, getReceiveKeyType

Methods inherited from interface edu.iu.dsc.tws.api.comms.channel.ChannelReceiver

sendCompleted

Constructor Detail

TreeBroadcast

public TreeBroadcast(TWSChannel channel,
                     int src,
                     java.util.Set<java.lang.Integer> dests,
                     MessageReceiver finalRcvr,
                     MessageType keyType,
                     MessageType dataType,
                     MessageSchema messageSchema)

TreeBroadcast

public TreeBroadcast(TWSChannel channel,
                     int src,
                     java.util.Set<java.lang.Integer> dests,
                     MessageReceiver finalRcvr,
                     MessageSchema messageSchema)

Method Detail

close

public void close()

Description copied from interface: DataFlowOperation

Close the operation

Specified by:

close in interface DataFlowOperation

reset

public void reset()

Description copied from interface: DataFlowOperation

Reset and get the operation to initial state

Specified by:

reset in interface DataFlowOperation

finish

public void finish(int target)

Description copied from interface: DataFlowOperation

If this is a larger transfer of dataflow style, we need to finish

Specified by:

finish in interface DataFlowOperation

getLogicalPlan

public LogicalPlan getLogicalPlan()

Description copied from interface: DataFlowOperation

Task plan associated with this operation

Specified by:

getLogicalPlan in interface DataFlowOperation

Returns:

task plan

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: DataFlowOperation

Returns a unique id for this operation. This would in most case be the edge number for the given operation.

Specified by:

getUniqueId in interface DataFlowOperation

Returns:

an unique id as a String

receiveMessage

public boolean receiveMessage(MessageHeader h,
                              java.lang.Object o)

Description copied from interface: ChannelReceiver

Receive a fully built message

Specified by:

receiveMessage in interface ChannelReceiver

Parameters:

h - the header

o - the built message

Returns:

true if accepted

init

public void init(Config cfg,
                 MessageType dType,
                 MessageType recvDType,
                 MessageType kType,
                 MessageType recvKType,
                 LogicalPlan tPlan,
                 int ed)

Initialize

init

public void init(Config cfg,
                 MessageType dType,
                 MessageType recvDType,
                 LogicalPlan tPlan,
                 int ed)

init

public void init(Config cfg,
                 MessageType dType,
                 LogicalPlan tPlan,
                 int ed)

Initialize

sendPartial

public boolean sendPartial(int src,
                           java.lang.Object message,
                           int flags)

Description copied from interface: DataFlowOperation

Use this to inject partial results in a distributed dataflow operation

Specified by:

sendPartial in interface DataFlowOperation

message - message

Returns:

true if message is accepted

isComplete

public boolean isComplete()

Description copied from interface: DataFlowOperation

Weather the operation doesn't have any pending sends or receives

Specified by:

isComplete in interface DataFlowOperation

Returns:

is complete

send

public boolean send(int src,
                    java.lang.Object message,
                    int flags)

Description copied from interface: DataFlowOperation

Send a send message, this call will work asynchronously

Specified by:

send in interface DataFlowOperation

Parameters:

src - source task

message - message as a generic object

Returns:

true if message is accepted

send

public boolean send(int src,
                    java.lang.Object message,
                    int flags,
                    int target)

Description copied from interface: DataFlowOperation

Send the message on a specific path

Specified by:

send in interface DataFlowOperation

Parameters:

src - source task

message - a generic java object

target - target task

Returns:

true if message is accepted

sendPartial

public boolean sendPartial(int src,
                           java.lang.Object message,
                           int flags,
                           int target)

Description copied from interface: DataFlowOperation

Send partial message on a specific path

Specified by:

sendPartial in interface DataFlowOperation

Parameters:

src - the source

message - message as a generic object

target - the final target

Returns:

true if message is accepted

progress

public boolean progress()

Description copied from interface: DataFlowOperation

Progress the pending dataflow operations

Specified by:

progress in interface DataFlowOperation

Returns:

true if there is more messages to communicationProgress, unless return false

isDelegateComplete

public boolean isDelegateComplete()

Specified by:

isDelegateComplete in interface DataFlowOperation

handleReceivedChannelMessage

public boolean handleReceivedChannelMessage(ChannelMessage currentMessage)

Description copied from interface: ChannelReceiver

Handle a partially received buffers

Specified by:

handleReceivedChannelMessage in interface ChannelReceiver

Parameters:

currentMessage - the message

Returns:

true if accepted

receiveSendInternally

public boolean receiveSendInternally(int src,
                                     int target,
                                     int path,
                                     int flags,
                                     java.lang.Object message)

Description copied from interface: ChannelReceiver

For partial receives the path and

Specified by:

receiveSendInternally in interface ChannelReceiver

Parameters:

src - the source

target - target to be sent

path - the path to be used

flags - flags

message - message

Returns:

true if success

receivingExecutors

protected java.util.Set<java.lang.Integer> receivingExecutors()

receiveExpectedTaskIds

public java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>> receiveExpectedTaskIds()

getSources

public java.util.Set<java.lang.Integer> getSources()

Description copied from interface: DataFlowOperation

Get the sources of the operation

Specified by:

getSources in interface DataFlowOperation

Returns:

source set

getTargets

public java.util.Set<java.lang.Integer> getTargets()

Description copied from interface: DataFlowOperation

Get targets of operation

Specified by:

getTargets in interface DataFlowOperation

Returns:

target set