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

Interface GroupCommDriver

All Known Subinterfaces:

GroupCommServiceDriver

All Known Implementing Classes:

GroupCommDriverImpl

@DefaultImplementation(value=GroupCommDriverImpl.class)
public interface GroupCommDriver

The driver side interface of Group Communication. which is the entry point for the service

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	getContextConfiguration()
Configuration	getServiceConfiguration()
Configuration	getTaskConfiguration(Configuration partialTaskConf)
boolean	isConfigured(ActiveContext activeContext) Tests whether the activeContext is a context configured.
CommunicationGroupDriver	newCommunicationGroup(Class<? extends Name<String>> groupName, Class<? extends Topology> topologyClass, int numberOfTasks, int customFanOut) Create a new communication group with the specified name, topology implementation, the minimum number of tasks needed in this group before communication can start, and a custom fanOut.
CommunicationGroupDriver	newCommunicationGroup(Class<? extends Name<String>> groupName, int numberOfTasks) Create a new communication group with the specified name.
CommunicationGroupDriver	newCommunicationGroup(Class<? extends Name<String>> groupName, int numberOfTasks, int customFanOut) Create a new communication group with the specified name, the minimum number of tasks needed in this group before communication can start, and a custom fanOut.

Method Detail

newCommunicationGroup

CommunicationGroupDriver newCommunicationGroup(Class<? extends Name<String>> groupName,
                                             int numberOfTasks)

Create a new communication group with the specified name. and the minimum number of tasks needed in this group before communication can start

Parameters:

groupName -

numberOfTasks -

Returns:

newCommunicationGroup

CommunicationGroupDriver newCommunicationGroup(Class<? extends Name<String>> groupName,
                                             int numberOfTasks,
                                             int customFanOut)

Create a new communication group with the specified name, the minimum number of tasks needed in this group before communication can start, and a custom fanOut.

Parameters:

groupName -

numberOfTasks -

customFanOut -

Returns:

newCommunicationGroup

CommunicationGroupDriver newCommunicationGroup(Class<? extends Name<String>> groupName,
                                             Class<? extends Topology> topologyClass,
                                             int numberOfTasks,
                                             int customFanOut)

Create a new communication group with the specified name, topology implementation, the minimum number of tasks needed in this group before communication can start, and a custom fanOut.

Parameters:

groupName -

topologyClass -

numberOfTasks -

customFanOut -

Returns:

isConfigured

boolean isConfigured(ActiveContext activeContext)

Tests whether the activeContext is a context configured. using the Group Communication Service

Parameters:

activeContext -

Returns:

getContextConfiguration

Configuration getContextConfiguration()

Returns:

Configuration needed for a Context that should have Group Communication Service enabled

getServiceConfiguration

Configuration getServiceConfiguration()

Returns:

Configuration needed to enable Group Communication as a Service

getTaskConfiguration

Configuration getTaskConfiguration(Configuration partialTaskConf)

Returns:

Configuration needed for a Task that should have Group Communication Service enabled