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

Class CommunicationGroupClientImpl

java.lang.Object

org.apache.reef.io.network.group.impl.task.CommunicationGroupClientImpl

All Implemented Interfaces:

CommunicationGroupClient, CommunicationGroupServiceClient

public class CommunicationGroupClientImpl
extends Object
implements CommunicationGroupServiceClient

Constructor Summary

Constructors

Constructor and Description
CommunicationGroupClientImpl(String groupName, String taskId, String driverId, GroupCommNetworkHandler groupCommNetworkHandler, Set<String> operatorConfigs, ConfigurationSerializer configSerializer, NetworkService<GroupCommunicationMessage> netService) Deprecated. in 0.14. Use the private constructor that receives an injector as a parameter instead.

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	initialize() Should not be used by user code.
void	updateTopology() Asks the driver to update the topology of this communication group.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommunicationGroupClientImpl

@Deprecated
@Inject
public CommunicationGroupClientImpl(String groupName,
                                              String taskId,
                                              String driverId,
                                              GroupCommNetworkHandler groupCommNetworkHandler,
                                              Set<String> operatorConfigs,
                                              ConfigurationSerializer configSerializer,
                                              NetworkService<GroupCommunicationMessage> netService)

Deprecated. in 0.14. Use the private constructor that receives an injector as a parameter instead.

Method Detail

getBroadcastSender

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getBroadcastSender in interface CommunicationGroupClient

Returns:

getReduceReceiver

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getReduceReceiver in interface CommunicationGroupClient

Returns:

getScatterSender

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getScatterSender in interface CommunicationGroupClient

Returns:

getGatherReceiver

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getGatherReceiver in interface CommunicationGroupClient

Returns:

getBroadcastReceiver

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getBroadcastReceiver in interface CommunicationGroupClient

Returns:

getReduceSender

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getReduceSender in interface CommunicationGroupClient

Returns:

getScatterReceiver

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getScatterReceiver in interface CommunicationGroupClient

Returns:

getGatherSender

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

Description copied from interface: CommunicationGroupClient

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

Specified by:

getGatherSender in interface CommunicationGroupClient

Returns:

initialize

public void initialize()

Description copied from interface: CommunicationGroupServiceClient

Should not be used by user code. Used for initialization of the communication group

Specified by:

initialize in interface CommunicationGroupServiceClient

getTopologyChanges

public GroupChanges getTopologyChanges()

Specified by:

getTopologyChanges in interface CommunicationGroupClient

Returns:

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

updateTopology

public void updateTopology()

Description copied from interface: CommunicationGroupClient

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

Specified by:

updateTopology in interface CommunicationGroupClient

getActiveSlaveTasks

public List<Identifier> getActiveSlaveTasks()

Specified by:

getActiveSlaveTasks in interface CommunicationGroupClient

Returns:

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

getTopologySimpleNodeRoot

public TopologySimpleNode getTopologySimpleNodeRoot()

Specified by:

getTopologySimpleNodeRoot in interface CommunicationGroupClient

Returns:

root node of simplified topology representation

getName

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

Specified by:

getName in interface CommunicationGroupClient

Returns:

The name configured on this communication group