This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T > Interface Template Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T > Interface Template Reference

Contains the Operator's topology graph. More...

Inherited by Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

Public Member Functions

void Initialize ()
 Initializes operator topology. More...
 
void SendToParent (T message, MessageType type)
 Sends the message to the parent Task. More...
 
void SendToChildren (T message, MessageType type)
 Sends the message to all child Tasks. More...
 
void ScatterToChildren (IList< T > messages, MessageType type)
 Splits the list of messages up evenly and sends each sublist to the child Tasks. More...
 
void ScatterToChildren (IList< T > messages, int count, MessageType type)
 Splits the list of messages up into chunks of the specified size and sends each sublist to the child Tasks. More...
 
void ScatterToChildren (IList< T > messages, List< string > order, MessageType type)
 Splits the list of messages up into chunks of the specified size and sends each sublist to the child Tasks in the specified order. More...
 
ReceiveFromParent ()
 Receive an incoming message from the parent Task. More...
 
IList< T > ReceiveListFromParent ()
 Receive a list of incoming messages from the parent Task. More...
 
ReceiveFromChildren (IReduceFunction< T > reduceFunction)
 Receives all messages from child Tasks and reduces them with the given IReduceFunction. More...
 
bool HasChildren ()
 Checks if the node has children More...
 

Detailed Description

Contains the Operator's topology graph.

Used to send or receive messages to/from operators in the same Communication Group.

Template Parameters
TThe type of message

Member Function Documentation

Checks if the node has children

Returns
true if children are there, false otherwise

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

Initializes operator topology.

Waits until all Tasks in the CommunicationGroup have registered themselves with the Name Service.

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

T Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.ReceiveFromChildren ( IReduceFunction< T >  reduceFunction)

Receives all messages from child Tasks and reduces them with the given IReduceFunction.

Parameters
reduceFunctionThe class used to reduce messages
Returns
The result of reducing messages

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

Receive an incoming message from the parent Task.

Returns
The parent Task's message

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

IList<T> Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.ReceiveListFromParent ( )

Receive a list of incoming messages from the parent Task.

Returns
The parent Task's list of messages

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

void Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.ScatterToChildren ( IList< T >  messages,
MessageType  type 
)

Splits the list of messages up evenly and sends each sublist to the child Tasks.

Parameters
messagesThe list of messages to scatter
typeThe message type

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

void Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.ScatterToChildren ( IList< T >  messages,
int  count,
MessageType  type 
)

Splits the list of messages up into chunks of the specified size and sends each sublist to the child Tasks.

Parameters
messagesThe list of messages to scatter
countThe size of each sublist
typeThe message type

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

void Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.ScatterToChildren ( IList< T >  messages,
List< string >  order,
MessageType  type 
)

Splits the list of messages up into chunks of the specified size and sends each sublist to the child Tasks in the specified order.

Parameters
messagesThe list of messages to scatter
orderThe order to send messages
typeThe message type

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

void Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.SendToChildren ( message,
MessageType  type 
)

Sends the message to all child Tasks.

Parameters
messageThe message to send
typeThe message type

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.

void Org.Apache.REEF.Network.Group.Task.IOperatorTopology< T >.SendToParent ( message,
MessageType  type 
)

Sends the message to the parent Task.

Parameters
messageThe message to send
typeThe message type

Implemented in Org.Apache.REEF.Network.Group.Task.Impl.OperatorTopology< T >.


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