Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver Interface Reference

Used to configure Group Communication operators in Reef driver. More...

Inherited by Org.Apache.REEF.Network.Group.Driver.Impl.CommunicationGroupDriver.

Public Member Functions
ICommunicationGroupDriver	AddBroadcast< T > (string operatorName, string masterTaskId, TopologyTypes topologyType, params IConfiguration[] configurations)
	Adds the Broadcast Group Communication operator to the communication group. More...
ICommunicationGroupDriver	AddBroadcast (string operatorName, string masterTaskId, TopologyTypes topologyType=TopologyTypes.Flat)
	Adds the Broadcast Group Communication operator to the communication group. More...
ICommunicationGroupDriver	AddReduce< T > (string operatorName, string masterTaskId, TopologyTypes topologyType, params IConfiguration[] configurations)
	Adds the Reduce Group Communication operator to the communication group. More...
ICommunicationGroupDriver	AddScatter (string operatorName, string senderId, TopologyTypes topologyType=TopologyTypes.Flat)
	Adds the Scatter Group Communication operator to the communication group with default Codec More...
ICommunicationGroupDriver	AddScatter< T > (string operatorName, string senderId, TopologyTypes topologyType, params IConfiguration[] configurations)
	Adds the Scatter Group Communication operator to the communication group. More...
ICommunicationGroupDriver	Build ()
	Finalizes the CommunicationGroupDriver. More...
void	AddTask (string taskId)
	Add a task to the communication group. More...
IConfiguration	GetGroupTaskConfiguration (string taskId)
	Get the Task Configuration for this communication group. More...

Properties
IList< string >	TaskIds [get]
	Returns the list of task ids that belong to this Communication Group More...

Detailed Description

Used to configure Group Communication operators in Reef driver.

All operators in the same Communication Group run on the the same set of tasks.

Member Function Documentation

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddBroadcast	(	string	operatorName,
		string	masterTaskId,
		TopologyTypes	topologyType = TopologyTypes.Flat
	)

Adds the Broadcast Group Communication operator to the communication group.

Default to IntCodec

Parameters

operatorName	The name of the broadcast operator
masterTaskId	The master task id in broadcast operator
topologyType	The topology type for the operator

Returns

The same CommunicationGroupDriver with the added Broadcast operator info

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddBroadcast< T >	(	string	operatorName,
		string	masterTaskId,
		TopologyTypes	topologyType,
		params IConfiguration[]	configurations
	)

Adds the Broadcast Group Communication operator to the communication group.

Template Parameters

T	The type of messages that operators will send

Parameters

configurations	The configuration for task
operatorName	The name of the broadcast operator
masterTaskId	The master task id in broadcast operator
topologyType	The topology type for the operator

Returns

The same CommunicationGroupDriver with the added Broadcast operator info

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddReduce< T >	(	string	operatorName,
		string	masterTaskId,
		TopologyTypes	topologyType,
		params IConfiguration[]	configurations
	)

Adds the Reduce Group Communication operator to the communication group.

Template Parameters

T	The type of messages that operators will send

Parameters

configurations	The configurations for task
operatorName	The name of the reduce operator
masterTaskId	The master task id for the typology
topologyType	The topology for the operator

Returns

The same CommunicationGroupDriver with the added Reduce operator info

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddScatter	(	string	operatorName,
		string	senderId,
		TopologyTypes	topologyType = TopologyTypes.Flat
	)

Adds the Scatter Group Communication operator to the communication group with default Codec

Parameters

operatorName	The name of the scatter operator
senderId	The sender id
topologyType	type of topology used in the operator

Returns

The same CommunicationGroupDriver with the added Scatter operator info

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddScatter< T >	(	string	operatorName,
		string	senderId,
		TopologyTypes	topologyType,
		params IConfiguration[]	configurations
	)

Adds the Scatter Group Communication operator to the communication group.

Template Parameters

T	The type of messages that operators will send

Parameters

configurations	The configuration for task
operatorName	The name of the scatter operator
senderId	The sender id
topologyType	type of topology used in the operator

Returns

The same CommunicationGroupDriver with the added Scatter operator info

void Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.AddTask

(

string

taskId

)

Add a task to the communication group.

The CommunicationGroupDriver must have called Build() before adding tasks to the group.

Parameters

taskId

The id of the task to add

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.Build

(

)

Finalizes the CommunicationGroupDriver.

After the CommunicationGroupDriver has been finalized, no more operators may be added to the group.

Returns

The same finalized CommunicationGroupDriver

IConfiguration Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.GetGroupTaskConfiguration

(

string

taskId

)

Get the Task Configuration for this communication group.

Must be called only after all tasks have been added to the CommunicationGroupDriver.

Parameters

taskId

The task id of the task that belongs to this Communication Group

Returns

The Task Configuration for this communication group

Property Documentation

IList<string> Org.Apache.REEF.Network.Group.Driver.ICommunicationGroupDriver.TaskIds

get

Returns the list of task ids that belong to this Communication Group

---

The documentation for this interface was generated from the following file:

• lang/cs/Org.Apache.REEF.Network/Group/Driver/ICommunicationGroupDriver.cs