edu.iu.dsc.tws.api.comms

Interface SingularReceiver

All Known Implementing Classes:

BAllReduceExample.FinalSingularReceiver, BReduceExample.FinalSingularReceiver, BroadcastStreamingOperation.BcastReceiver, DirectStreamingOperation.DirectReceiver, PartitionStreamingOperation.PartitionBulkReceiver, PipeBatchOperation.PartitionReceiver, ReduceBatchOperation.FinalSingularReceiver, SAllReduceExample.FinalSingularReceiver, SBroadcastExample.BCastReceiver, SDirectExample.PartitionReceiver, SKeyedPartitionExample.PartitionReceiver, SKeyedReduceExample.FinalSingularReceiver, SPartitionExample.PartitionReceiver, SReduceExample.FinalSingularReceiver, SVMCommsReducer.FinalSingularReceiver, WordAggregate

public interface SingularReceiver

Interface for receiving a single value. If the value is received successfully, it should return true. This interface will be called multiple times with the same message until it returns true.

Method Summary

Modifier and Type	Method and Description
void	init(Config cfg, java.util.Set<java.lang.Integer> targets) Initialize a receiver
boolean	receive(int target, java.lang.Object object) Receive an object for a target id.
default boolean	sync(int target, byte[] message) A sync event has occurred

Method Detail

init

void init(Config cfg,
          java.util.Set<java.lang.Integer> targets)

Initialize a receiver

Parameters:

cfg - configuration

targets - the target ids

receive

boolean receive(int target,
                java.lang.Object object)

Receive an object for a target id.

Parameters:

target - target id

object - object

Returns:

true if the receive is accepted

sync

default boolean sync(int target,
                     byte[] message)

A sync event has occurred

Parameters:

target - the target id

Returns:

true if sync event is accepted