org.apache.reef.io.network.group.api.task

Interface CommunicationGroupClient

All Known Subinterfaces:

CommunicationGroupServiceClient

All Known Implementing Classes:

CommunicationGroupClientImpl

@DefaultImplementation(value=CommunicationGroupClientImpl.class)
public interface CommunicationGroupClient

The Task side interface of a communication group. Lets one get the operators configured for this task and use them for communication between tasks configured in this communication group

Method Summary

Methods

Modifier and Type	Method and Description
List<Identifier>	getActiveSlaveTasks()
Broadcast.Receiver	getBroadcastReceiver(Class<? extends Name<String>> operatorName) The broadcast receiver configured on this communication group.
Broadcast.Sender	getBroadcastSender(Class<? extends Name<String>> operatorName) The broadcast sender configured on this communication group.
Gather.Receiver	getGatherReceiver(Class<? extends Name<String>> operatorName) Return the gather receiver configured on this communication group.
Gather.Sender	getGatherSender(Class<? extends Name<String>> operatorName) Return the gather sender configured on this communication group.
Class<? extends Name<String>>	getName()
Reduce.Receiver	getReduceReceiver(Class<? extends Name<String>> operatorName) The reduce receiver configured on this communication group.
Reduce.Sender	getReduceSender(Class<? extends Name<String>> operatorName) The reduce sender configured on this communication group.
Scatter.Receiver	getScatterReceiver(Class<? extends Name<String>> operatorName) Return the scatter receiver configured on this communication group.
Scatter.Sender	getScatterSender(Class<? extends Name<String>> operatorName) Return the scatter sender configured on this communication group.
GroupChanges	getTopologyChanges()
TopologySimpleNode	getTopologySimpleNodeRoot()
void	updateTopology() Asks the driver to update the topology of this communication group.

Method Detail

getName

Class<? extends Name<String>> getName()

Returns:

The name configured on this communication group

getBroadcastSender

Broadcast.Sender getBroadcastSender(Class<? extends Name<String>> operatorName)

The broadcast sender configured on this communication group. with the given oepratorName

Parameters:

operatorName -

Returns:

getBroadcastReceiver

Broadcast.Receiver getBroadcastReceiver(Class<? extends Name<String>> operatorName)

The broadcast receiver configured on this communication group. with the given oepratorName

Parameters:

operatorName -

Returns:

getReduceReceiver

Reduce.Receiver getReduceReceiver(Class<? extends Name<String>> operatorName)

The reduce receiver configured on this communication group. with the given operatorName

Parameters:

operatorName -

Returns:

getReduceSender

Reduce.Sender getReduceSender(Class<? extends Name<String>> operatorName)

The reduce sender configured on this communication group. with the given operatorName

Parameters:

operatorName -

Returns:

getScatterSender

Scatter.Sender getScatterSender(Class<? extends Name<String>> operatorName)

Return the scatter sender configured on this communication group. operatorName is used to specify the scatter sender to return.

Parameters:

operatorName -

Returns:

getScatterReceiver

Scatter.Receiver getScatterReceiver(Class<? extends Name<String>> operatorName)

Return the scatter receiver configured on this communication group. operatorName is used to specify the scatter receiver to return.

Parameters:

operatorName -

Returns:

getGatherReceiver

Gather.Receiver getGatherReceiver(Class<? extends Name<String>> operatorName)

Return the gather receiver configured on this communication group. operatorName is used to specify the gather receiver to return.

Parameters:

operatorName -

Returns:

getGatherSender

Gather.Sender getGatherSender(Class<? extends Name<String>> operatorName)

Return the gather sender configured on this communication group. operatorName is used to specify the gather sender to return.

Parameters:

operatorName -

Returns:

getTopologyChanges

GroupChanges getTopologyChanges()

Returns:

Changes in topology of this communication group since the last time this method was called

getActiveSlaveTasks

List<Identifier> getActiveSlaveTasks()

Returns:

list of current active tasks, last updated during updateTopology()

getTopologySimpleNodeRoot

TopologySimpleNode getTopologySimpleNodeRoot()

Returns:

root node of simplified topology representation

updateTopology

void updateTopology()

Asks the driver to update the topology of this communication group. This can be an expensive call depending on what the minimum number of tasks is for this group to function as this first tells the driver, driver then tells the affected tasks and the driver gives a green only after affected tasks have had a chance to be sure that their topology will be updated before the next message is communicated