edu.iu.dsc.tws.api.comms.messaging

Interface MessageReceiver

All Known Implementing Classes:

AllGatherBatchFinalReceiver, AllGatherStreamingFinalReceiver, AllReduceBatchFinalReceiver, AllReduceStreamingFinalReceiver, BaseGatherBatchReceiver, BaseReduceBatchFinalReceiver, BcastBatchFinalReceiver, BcastGatherBatchReceiver, BcastGatheStreamingReceiver, BcastStreamingFinalReceiver, DGatherBatchFinalReceiver, DirectBatchFinalReceiver, DirectStreamingFinalReceiver, DKGatherBatchFinalReceiver, DPartitionBatchFinalReceiver, GatherBatchFinalReceiver, GatherBatchPartialReceiver, GatherStreamingFinalReceiver, GatherStreamingPartialReceiver, JoinBatchPartialReceiver, JoinPartitionBatchFinalReceiver, KeyedReceiver, KGatherBatchFinalReceiver, KGatherBatchPartialReceiver, KGatherStreamingFinalReceiver, KGatherStreamingPartialReceiver, KGatherStreamingReceiver, KReduceBatchFinalReceiver, KReduceBatchPartialReceiver, KReduceBatchReceiver, KReduceStreamingFinalReceiver, KReduceStreamingPartialReceiver, KReduceStreamingReceiver, PartitionBatchFinalReceiver, PartitionPartialReceiver, PartitionStreamingFinalReceiver, ReduceBatchFinalReceiver, ReduceBatchPartialReceiver, ReduceBatchReceiver, ReduceStreamingFinalReceiver, ReduceStreamingPartialReceiver, ReduceStreamingReceiver, SourceReceiver, TargetFinalReceiver, TargetPartialReceiver, TargetReceiver

public interface MessageReceiver

This is the primary interface for receiving messages in an operation.

Method Summary

Modifier and Type	Method and Description
default void	clean() Clean any state associated with the receiver and go to initial state
default void	close() Close the receiver
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
default boolean	onMessage(int source, int path, int target, int flags, int tag, java.lang.Object object) The actual message callback
boolean	onMessage(int source, int path, int target, int flags, java.lang.Object object) The actual message callback
boolean	progress() This method will be called by the communicationProgress

Method Detail

init

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

target -> source tasks

Parameters:

expectedIds - expected task ids

onMessage

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

The actual message callback

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

onMessage

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

The actual message callback

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

tag - tag value to identify this operation

object - the actual message

Returns:

true if the message is accepted

progress

boolean progress()

This method will be called by the communicationProgress

Returns:

true if needs further communicationProgress

isComplete

boolean isComplete()

Weather we are complete a set of messages

Returns:

true if a round is complete with syncs

close

default void close()

Close the receiver

clean

default void clean()

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