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

Used to create Communication Groups for Group Communication Operators. More...

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

Public Member Functions
ICommunicationGroupDriver	NewCommunicationGroup (string groupName, int numTasks)
	Create a new CommunicationGroup with the given name and number of tasks/operators. More...
void	RemoveCommunicationGroup (string groupName)
	remove a communication group Throw ArgumentException if the group does not exist More...
IConfiguration	GetContextConfiguration ()
	Generates context configuration with a unique identifier. More...
IConfiguration	GetServiceConfiguration ()
	Get the service configuration required for running Group Communication on Reef tasks. More...
bool	IsMasterTaskContext (IActiveContext activeContext)
	Checks whether this active context can be used to run the Master Task. More...
bool	IsMasterContextConfiguration (IConfiguration contextConfiguration)
	Checks whether this context configuration is used to configure the Master Task. More...
int	GetContextNum (IActiveContext activeContext)
	Gets the context number associated with the Active Context id. More...
IConfiguration	GetGroupCommTaskConfiguration (string taskId)
	Get the configuration for a particular task. More...

Properties
string	MasterTaskId [get]
	Returns the identifier for the master task More...
ICommunicationGroupDriver	DefaultGroup [get]

Detailed Description

Used to create Communication Groups for Group Communication Operators.

Also manages configuration for Group Communication tasks/services.

Member Function Documentation

IConfiguration Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.GetContextConfiguration

(

)

Generates context configuration with a unique identifier.

Returns

The configured context configuration

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

int Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.GetContextNum

(

IActiveContext

activeContext

)

Gets the context number associated with the Active Context id.

Parameters

activeContext

The active context to check

Returns

The context number associated with the active context id

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

IConfiguration Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.GetGroupCommTaskConfiguration

(

string

taskId

)

Get the configuration for a particular task.

The task may belong to many Communication Groups, so each one is serialized in the configuration as a SerializedGroupConfig.

The user must merge their part of task configuration (task id, task class) with this returned Group Communication task configuration.

Parameters

taskId

The id of the task Configuration to generate

Returns

The Group Communication task configuration with communication group and operator configuration set.

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

IConfiguration Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.GetServiceConfiguration

(

)

Get the service configuration required for running Group Communication on Reef tasks.

Returns

The service configuration for the Reef tasks

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

bool Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.IsMasterContextConfiguration

(

IConfiguration

contextConfiguration

)

Checks whether this context configuration is used to configure the Master Task.

Parameters

contextConfiguration

The context configuration to check

Returns

True if the context configuration is used to configure the Master Task, otherwise false.

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

bool Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.IsMasterTaskContext

(

IActiveContext

activeContext

)

Checks whether this active context can be used to run the Master Task.

Parameters

activeContext

The active context to check

Returns

True if the active context can run the Master task, otherwise false.

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.NewCommunicationGroup	(	string	groupName,
		int	numTasks
	)

Create a new CommunicationGroup with the given name and number of tasks/operators.

Parameters

groupName	The new group name
numTasks	The number of tasks/operators in the group.

Returns

The new Communication Group

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

void Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.RemoveCommunicationGroup

(

string

groupName

)

remove a communication group Throw ArgumentException if the group does not exist

Parameters

groupName

Implemented in Org.Apache.REEF.Network.Group.Driver.Impl.GroupCommDriver.

Property Documentation

ICommunicationGroupDriver Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.DefaultGroup

get

string Org.Apache.REEF.Network.Group.Driver.IGroupCommDriver.MasterTaskId

get

Returns the identifier for the master task

---

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

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