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

Interface CommunicationGroupDriver

All Known Implementing Classes:

CommunicationGroupDriverImpl

@DefaultImplementation(value=CommunicationGroupDriverImpl.class)
public interface CommunicationGroupDriver

The driver side interface of a Communication Group Lets one add operators and tasks. Main function is to extract the configuration related to the Group Communication for a task in the comm group

Method Summary

Methods

Modifier and Type	Method and Description
CommunicationGroupDriver	addBroadcast(Class<? extends Name<String>> operatorName, BroadcastOperatorSpec spec) Add the broadcast operator specified by the.
CommunicationGroupDriver	addGather(Class<? extends Name<String>> operatorName, GatherOperatorSpec spec) Add the gather operator specified by operatorName and spec.
CommunicationGroupDriver	addReduce(Class<? extends Name<String>> operatorName, ReduceOperatorSpec spec) Add the reduce operator specified by the.
CommunicationGroupDriver	addScatter(Class<? extends Name<String>> operatorName, ScatterOperatorSpec spec) Add the scatter operator specified by operatorName and spec.
void	addTask(Configuration partialTaskConf) Add the task represented by this configuration to this communication group.
void	finalise() This signals to the service that no more.
Configuration	getTaskConfiguration(Configuration taskConf) Returns a configuration that includes the partial task configuration passed in as 'taskConf' and makes the current communication group and the operators configured on it available on the Task side.

Method Detail

addBroadcast

CommunicationGroupDriver addBroadcast(Class<? extends Name<String>> operatorName,
                                    BroadcastOperatorSpec spec)

Add the broadcast operator specified by the. 'spec' with name 'operatorName' into this Communication Group

Parameters:

operatorName -

spec -

Returns:

addReduce

CommunicationGroupDriver addReduce(Class<? extends Name<String>> operatorName,
                                 ReduceOperatorSpec spec)

Add the reduce operator specified by the. 'spec' with name 'operatorName' into this Communication Group

Parameters:

operatorName -

spec -

Returns:

addScatter

CommunicationGroupDriver addScatter(Class<? extends Name<String>> operatorName,
                                  ScatterOperatorSpec spec)

Add the scatter operator specified by operatorName and spec.

Parameters:

operatorName -

spec -

Returns:

addGather

CommunicationGroupDriver addGather(Class<? extends Name<String>> operatorName,
                                 GatherOperatorSpec spec)

Add the gather operator specified by operatorName and spec.

Parameters:

operatorName -

spec -

Returns:

finalise

void finalise()

This signals to the service that no more. operator specs will be added to this communication group and an attempt to do that will throw an IllegalStateException

getTaskConfiguration

Configuration getTaskConfiguration(Configuration taskConf)

Returns a configuration that includes the partial task configuration passed in as 'taskConf' and makes the current communication group and the operators configured on it available on the Task side. Provides for injection of GroupCommClient

Parameters:

taskConf -

Returns:

addTask

void addTask(Configuration partialTaskConf)

Add the task represented by this configuration to this communication group. The configuration needs to contain the id of the Task that will be used

Parameters:

partialTaskConf -