org.apache.flink.graph.pregel

Class MessageCombiner<K,Message>

java.lang.Object

org.apache.flink.graph.pregel.MessageCombiner<K,Message>

Type Parameters:

K - The type of the vertex id

Message - The type of the message sent between vertices along the edges.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PregelSSSP.SSSPCombiner

public abstract class MessageCombiner<K,Message>
extends Object
implements Serializable

The base class for combining messages sent during a VertexCentricIteration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageCombiner()

Method Summary

Modifier and Type	Method and Description
abstract void	combineMessages(MessageIterator<Message> messages) Combines messages sent from different vertices to a target vertex.
void	sendCombinedMessage(Message combinedMessage) Sends the combined message to the target vertex.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageCombiner

public MessageCombiner()

Method Detail

combineMessages

public abstract void combineMessages(MessageIterator<Message> messages)
                              throws Exception

Combines messages sent from different vertices to a target vertex. Implementing this method might reduce communication costs during a vertex-centric iteration.

Parameters:

messages - the input messages to combine

Throws:

Exception

sendCombinedMessage

public final void sendCombinedMessage(Message combinedMessage)

Sends the combined message to the target vertex.

Parameters:

combinedMessage -

Throws:

Exception