Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Network.Group.Task.Impl.GroupCommClient Class Reference

Used by Tasks to fetch CommunicationGroupClients. More...

Inherits Org.Apache.REEF.Network.Group.Task.IGroupCommClient.

Public Member Functions

 GroupCommClient ([Parameter(typeof(GroupCommConfigurationOptions.SerializedGroupConfigs))] ISet< string > groupConfigs, [Parameter(typeof(TaskConfigurationOptions.Identifier))] string taskId, StreamingNetworkService< GeneralGroupCommunicationMessage > networkService, AvroConfigurationSerializer configSerializer, IInjector injector)
 Creates a new WritableGroupCommClient and registers the task ID with the Name Server. More...
 
void Initialize (CancellationTokenSource cancellationSource=null)
 This is to ensure all the nodes in the groups are registered before starting communications. More...
 
ICommunicationGroupClient GetCommunicationGroup (string groupName)
 Gets the CommunicationGroupClient for the given group name. More...
 
void Dispose ()
 Disposes of the GroupCommClient's services. More...
 

Detailed Description

Used by Tasks to fetch CommunicationGroupClients.

Writable version

Constructor & Destructor Documentation

◆ GroupCommClient()

Org.Apache.REEF.Network.Group.Task.Impl.GroupCommClient.GroupCommClient ( [Parameter(typeof(GroupCommConfigurationOptions.SerializedGroupConfigs))] ISet< string >  groupConfigs,
[Parameter(typeof(TaskConfigurationOptions.Identifier))] string  taskId,
StreamingNetworkService< GeneralGroupCommunicationMessage networkService,
AvroConfigurationSerializer  configSerializer,
IInjector  injector 
)
inline

Creates a new WritableGroupCommClient and registers the task ID with the Name Server.

Parameters
groupConfigsThe set of serialized Group Communication configurations
taskIdThe identifier for this task
networkServiceThe writable network service used to send messages
configSerializerUsed to deserialize Group Communication configuration
injectorinjector forked from the injector that creates this instance

Member Function Documentation

◆ Dispose()

void Org.Apache.REEF.Network.Group.Task.Impl.GroupCommClient.Dispose ( )
inline

Disposes of the GroupCommClient's services.

◆ GetCommunicationGroup()

ICommunicationGroupClient Org.Apache.REEF.Network.Group.Task.Impl.GroupCommClient.GetCommunicationGroup ( string  groupName)
inline

Gets the CommunicationGroupClient for the given group name.

Parameters
groupNameThe name of the CommunicationGroupClient
Returns
The CommunicationGroupClient

Implements Org.Apache.REEF.Network.Group.Task.IGroupCommClient.

◆ Initialize()

void Org.Apache.REEF.Network.Group.Task.Impl.GroupCommClient.Initialize ( CancellationTokenSource  cancellationSource = null)
inline

This is to ensure all the nodes in the groups are registered before starting communications.

Parameters
cancellationSource

Implements Org.Apache.REEF.Network.Group.Task.IGroupCommClient.


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