edu.iu.dsc.tws.comms.dfw

Class OneToOne

java.lang.Object

edu.iu.dsc.tws.comms.dfw.OneToOne

All Implemented Interfaces:

ChannelReceiver, DataFlowOperation

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

A direct data flow operation sends peer to peer messages, the messages are between one source and another task

Constructor Summary

Constructors

Constructor and Description
OneToOne(TWSChannel channel, java.util.List<java.lang.Integer> src, java.util.List<java.lang.Integer> target, MessageReceiver finalRcvr, Config cfg, MessageType dataType, LogicalPlan plan, int edge, MessageSchema messageSchema)
OneToOne(TWSChannel channel, java.util.List<java.lang.Integer> src, java.util.List<java.lang.Integer> target, MessageReceiver finalRcvr, Config cfg, MessageType dataType, MessageType recvDataType, LogicalPlan plan, int edge, MessageSchema messageSchema)

Method Summary

Modifier and Type	Method and Description
void	close() Close the operation
void	finish(int source) If this is a larger transfer of dataflow style, we need to finish
MessageType	getDataType() returns the data type that is associated with the data flow operation
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	isComplete() Weather the operation doesn't have any pending sends or receives
boolean	isDelegateComplete()
boolean	progress() Progress the pending dataflow operations
protected java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>>	receiveExpectedTaskIds()
boolean	receiveMessage(MessageHeader header, java.lang.Object object) Receive a fully built message
boolean	receiveSendInternally(int source, int target, int path, int flags, java.lang.Object message) For partial receives the path and
void	reset() Reset and get the operation to initial state
boolean	send(int source, java.lang.Object message, int flags) Send a send message, this call will work asynchronously
boolean	send(int source, java.lang.Object message, int flags, int target) Send the message on a specific path
boolean	sendPartial(int source, java.lang.Object message, int flags) Use this to inject partial results in a distributed dataflow operation
boolean	sendPartial(int source, 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

getKeyType, getReceiveDataType, getReceiveKeyType

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

handleReceivedChannelMessage, sendCompleted

Constructor Detail

OneToOne

public OneToOne(TWSChannel channel,
                java.util.List<java.lang.Integer> src,
                java.util.List<java.lang.Integer> target,
                MessageReceiver finalRcvr,
                Config cfg,
                MessageType dataType,
                MessageType recvDataType,
                LogicalPlan plan,
                int edge,
                MessageSchema messageSchema)

OneToOne

public OneToOne(TWSChannel channel,
                java.util.List<java.lang.Integer> src,
                java.util.List<java.lang.Integer> target,
                MessageReceiver finalRcvr,
                Config cfg,
                MessageType dataType,
                LogicalPlan plan,
                int edge,
                MessageSchema messageSchema)

Method Detail

receiveMessage

public boolean receiveMessage(MessageHeader header,
                              java.lang.Object object)

Description copied from interface: ChannelReceiver

Receive a fully built message

Specified by:

receiveMessage in interface ChannelReceiver

Parameters:

header - the header

object - the built message

Returns:

true if accepted

receiveSendInternally

public boolean receiveSendInternally(int source,
                                     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:

source - the source

target - target to be sent

path - the path to be used

flags - flags

message - message

Returns:

true if success

receiveExpectedTaskIds

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

sendPartial

public boolean sendPartial(int source,
                           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

send

public boolean send(int source,
                    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:

source - source task

message - message as a generic object

Returns:

true if message is accepted

send

public boolean send(int source,
                    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:

source - source task

message - a generic java object

target - target task

Returns:

true if message is accepted

sendPartial

public boolean sendPartial(int source,
                           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:

source - 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

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

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 source)

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

getDataType

public MessageType getDataType()

Description copied from interface: DataFlowOperation

returns the data type that is associated with the data flow operation

Specified by:

getDataType in interface DataFlowOperation

Returns:

the MessageType or an UnsupportedOperationException

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