Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | Properties | List of all members
Org.Apache.REEF.Network.Group.Operators.Impl.ReduceReceiver< T > Class Template Reference

Group Communication operator used to receive and reduce messages in pipelined fashion. More...

Inherits Org.Apache.REEF.Network.Group.Operators.IReduceReceiver< T >, and Org.Apache.REEF.Network.Group.Operators.IGroupCommOperatorInternal.

Public Member Functions

Reduce (CancellationTokenSource cancellationSource=null)
 Receives messages sent by all ReduceSenders and aggregates them using the specified IReduceFunction. More...
 

Properties

string OperatorName [get]
 Returns the name of the reduce operator More...
 
string GroupName [get]
 Returns the name of the operator's CommunicationGroup. More...
 
int Version [get]
 Returns the operator version. More...
 
IReduceFunction< T > ReduceFunction [get]
 Returns the class used to reduce incoming messages sent by ReduceSenders. More...
 
IPipelineDataConverter< T > PipelineDataConverter [get]
 Returns the IPipelineDataConvert used to convert messages to pipeline form and vice-versa More...
 
- Properties inherited from Org.Apache.REEF.Network.Group.Operators.IReduceReceiver< T >
IReduceFunction< T > ReduceFunction [get]
 Returns the class used to reduce incoming messages sent by ReduceSenders. More...
 
- Properties inherited from Org.Apache.REEF.Network.Group.Operators.IGroupCommOperator< T >
string OperatorName [get]
 The operator name. More...
 
string GroupName [get]
 The name of the operator's CommunicationGroup. More...
 
int Version [get]
 The operator version number. More...
 

Detailed Description

Group Communication operator used to receive and reduce messages in pipelined fashion.

Template Parameters
TThe message type

Member Function Documentation

◆ Reduce()

T Org.Apache.REEF.Network.Group.Operators.Impl.ReduceReceiver< T >.Reduce ( CancellationTokenSource  cancellationSource = null)
inline

Receives messages sent by all ReduceSenders and aggregates them using the specified IReduceFunction.

Parameters
cancellationSourceThe cancellation token for the data reading operation cancellation
Returns
The single aggregated data

Implements Org.Apache.REEF.Network.Group.Operators.IReduceReceiver< T >.

Property Documentation

◆ GroupName

Returns the name of the operator's CommunicationGroup.

◆ OperatorName

Returns the name of the reduce operator

◆ PipelineDataConverter

Returns the IPipelineDataConvert used to convert messages to pipeline form and vice-versa

◆ ReduceFunction

Returns the class used to reduce incoming messages sent by ReduceSenders.

◆ Version

Returns the operator version.


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