edu.iu.dsc.tws.api.comms

Interface DataFlowOperation

All Known Implementing Classes:

AllGather, AllReduce, MToNChain, MToNRing, MToNSimple, MToOneTree, OneToOne, TreeBroadcast

public interface DataFlowOperation

The communication operation interface.

Method Summary

Modifier and Type	Method and Description
void	close() Close the operation
default void	finish(int source) If this is a larger transfer of dataflow style, we need to finish
default MessageType	getDataType() returns the data type that is associated with the data flow operation
default MessageType	getKeyType() returns the key type that is associated with the data flow operation
LogicalPlan	getLogicalPlan() Task plan associated with this operation
default MessageType	getReceiveDataType() returns the data type that is associated with the data flow operation
default MessageType	getReceiveKeyType() returns the key type that is associated with the data flow operation
default java.util.Set<java.lang.Integer>	getSources() Get the sources of the operation
default java.util.Set<java.lang.Integer>	getTargets() Get targets of operation
java.lang.String	getUniqueId() Returns a unique id for this operation.
default boolean	isComplete() Weather the operation doesn't have any pending sends or receives
default boolean	isDelegateComplete()
boolean	progress() Progress the pending dataflow operations
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

Method Detail

sendPartial

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

Use this to inject partial results in a distributed dataflow operation

Parameters:

message - message

Returns:

true if message is accepted

send

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

Send a send message, this call will work asynchronously

Parameters:

source - source task

message - message as a generic object

Returns:

true if message is accepted

send

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

Send the message on a specific path

Parameters:

source - source task

message - a generic java object

target - target task

Returns:

true if message is accepted

sendPartial

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

Send partial message on a specific path

Parameters:

source - the source

message - message as a generic object

target - the final target

Returns:

true if message is accepted

progress

boolean progress()

Progress the pending dataflow operations

Returns:

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

close

void close()

Close the operation

reset

void reset()

Reset and get the operation to initial state

isComplete

default boolean isComplete()

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

Returns:

is complete

isDelegateComplete

default boolean isDelegateComplete()

finish

default void finish(int source)

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

getKeyType

default MessageType getKeyType()

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

Returns:

the MessageType or an UnsupportedOperationException

getReceiveKeyType

default MessageType getReceiveKeyType()

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

Returns:

the MessageType or an UnsupportedOperationException

getDataType

default MessageType getDataType()

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

Returns:

the MessageType or an UnsupportedOperationException

getReceiveDataType

default MessageType getReceiveDataType()

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

Returns:

the MessageType or an UnsupportedOperationException

getLogicalPlan

LogicalPlan getLogicalPlan()

Task plan associated with this operation

Returns:

task plan

getUniqueId

java.lang.String getUniqueId()

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

Returns:

an unique id as a String

getSources

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

Get the sources of the operation

Returns:

source set

getTargets

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

Get targets of operation

Returns:

target set