org.apache.giraph.block_app.library

Class SendMessageChain<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,P>

java.lang.Object

org.apache.giraph.block_app.library.SendMessageChain<I,V,E,P>

Type Parameters:

I - Vertex id type

V - Vertex value type

E - Edge value type

P - Previous value

public class SendMessageChain<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,P>
extends Object

Utility class for creating sequences of sending replies to received messages. Current instance of this object represents partial chain, where we have specified which messages will be send at the lastly defined link in the chain thus far, but we haven't specified yet what to do when vertices receive them. Contains set of: - static startX methods, used to create the chain - thenX methods, used to add one more Piece to the chain, can be "chained" arbitrary number of times. - endX methods, used to finish the chain, returning the Block representing the whole chain If messageSupplier or targetsSupplier returns null, current vertex is not going to send any messages.

Method Summary

Modifier and Type	Method and Description
Block	endConsume(ConsumerWithVertex<I,V,E,P> messagesConsumer) End chain by processing messages received within the last link in the chain.
Block	endCustom(Function<SupplierFromVertex<I,V,E,P>,Block> createBlockToAttach) End chain by providing a function that will produce Block to be attached to the end of current chain, given a supplier of messages received within the last link in the chain.
<S,R extends org.apache.hadoop.io.Writable> Block	endReduce(String name, ReduceOperation<S,R> reduceOp, FunctionWithVertex<I,V,E,P,S> valueSupplier, Consumer<R> reducedValueConsumer) End chain by giving received messages to valueSupplier, to produce value that should be reduced, and consumed on master by reducedValueConsumer.
<S,R extends org.apache.hadoop.io.Writable> Block	endReduceWithMaster(String name, ReduceOperation<S,R> reduceOp, FunctionWithVertex<I,V,E,P,S> valueSupplier, PairConsumer<R,BlockMasterApi> reducedValueConsumer) End chain by giving received messages to valueSupplier, to produce value that should be reduced, and consumed on master by reducedValueConsumer.
static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,P extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,P>	startCustom(Function<ConsumerWithVertex<I,V,E,P>,Block> createStartingBlock) Start chain by providing a function that will produce Block representing beginning of the chain, given a consumer of messages send by the last link in the created block.
static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>>	startSend(String name, Class<M> messageClass, SupplierFromVertex<I,V,E,M> messageSupplier, SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier) Start chain with sending message provided by messageSupplier to all targets provided by targetsSupplier.
static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M>	startSend(String name, MessageCombiner<? super I,M> messageCombiner, SupplierFromVertex<I,V,E,M> messageSupplier, SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier) Start chain with sending message provided by messageSupplier to all targets provided by targetsSupplier, and use given messageCombiner to combine messages together.
static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>>	startSendToNeighbors(String name, Class<M> messageClass, SupplierFromVertex<I,V,E,M> messageSupplier) Start chain with sending message provided by messageSupplier to all neighbors of a current vertex.
static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M>	startSendToNeighbors(String name, MessageCombiner<? super I,M> messageCombiner, SupplierFromVertex<I,V,E,M> messageSupplier) Start chain with sending message provided by messageSupplier to all neighbors of a current vertex, and use given messageCombiner to combine messages together.
<M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>>	thenSend(String name, Class<M> messageClass, FunctionWithVertex<I,V,E,P,M> messageSupplier, SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier) Give previously received message(s) to messageSupplier, and send message it returns to all targets provided by targetsSupplier.
<M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M>	thenSend(String name, MessageCombiner<? super I,M> messageCombiner, FunctionWithVertex<I,V,E,P,M> messageSupplier, SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier) Give previously received message(s) to messageSupplier, and send message it returns to all targets provided by targetsSupplier, and use given messageCombiner to combine messages together.
<M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>>	thenSendToNeighbors(String name, Class<M> messageClass, FunctionWithVertex<I,V,E,P,M> messageSupplier) Give previously received message(s) to messageSupplier, and send message it returns to all neighbors of current vertex.
<M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M>	thenSendToNeighbors(String name, MessageCombiner<? super I,M> messageCombiner, FunctionWithVertex<I,V,E,P,M> messageSupplier) Give previously received message(s) to messageSupplier, and send message it returns to all neighbors of current vertex, and use given messageCombiner to combine messages together.

Methods inherited from class java.lang.Object

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

Method Detail

startSend

public static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>> startSend(String name,
                                                                                                                                                                                                                                        Class<M> messageClass,
                                                                                                                                                                                                                                        SupplierFromVertex<I,V,E,M> messageSupplier,
                                                                                                                                                                                                                                        SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier)

Start chain with sending message provided by messageSupplier to all targets provided by targetsSupplier.

startSend

public static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M> startSend(String name,
                                                                                                                                                                                                                              MessageCombiner<? super I,M> messageCombiner,
                                                                                                                                                                                                                              SupplierFromVertex<I,V,E,M> messageSupplier,
                                                                                                                                                                                                                              SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier)

Start chain with sending message provided by messageSupplier to all targets provided by targetsSupplier, and use given messageCombiner to combine messages together.

startSendToNeighbors

public static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>> startSendToNeighbors(String name,
                                                                                                                                                                                                                                                   Class<M> messageClass,
                                                                                                                                                                                                                                                   SupplierFromVertex<I,V,E,M> messageSupplier)

Start chain with sending message provided by messageSupplier to all neighbors of a current vertex.

startSendToNeighbors

public static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M> startSendToNeighbors(String name,
                                                                                                                                                                                                                                         MessageCombiner<? super I,M> messageCombiner,
                                                                                                                                                                                                                                         SupplierFromVertex<I,V,E,M> messageSupplier)

Start chain with sending message provided by messageSupplier to all neighbors of a current vertex, and use given messageCombiner to combine messages together.

startCustom

public static <I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,P extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,P> startCustom(Function<ConsumerWithVertex<I,V,E,P>,Block> createStartingBlock)

Start chain by providing a function that will produce Block representing beginning of the chain, given a consumer of messages send by the last link in the created block.

thenSend

public <M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>> thenSend(String name,
                                                                                              Class<M> messageClass,
                                                                                              FunctionWithVertex<I,V,E,P,M> messageSupplier,
                                                                                              SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier)

Give previously received message(s) to messageSupplier, and send message it returns to all targets provided by targetsSupplier.

thenSendToNeighbors

public <M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,Iterable<M>> thenSendToNeighbors(String name,
                                                                                                         Class<M> messageClass,
                                                                                                         FunctionWithVertex<I,V,E,P,M> messageSupplier)

Give previously received message(s) to messageSupplier, and send message it returns to all neighbors of current vertex.

thenSend

public <M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M> thenSend(String name,
                                                                                    MessageCombiner<? super I,M> messageCombiner,
                                                                                    FunctionWithVertex<I,V,E,P,M> messageSupplier,
                                                                                    SupplierFromVertex<I,V,E,Iterator<I>> targetsSupplier)

Give previously received message(s) to messageSupplier, and send message it returns to all targets provided by targetsSupplier, and use given messageCombiner to combine messages together.

thenSendToNeighbors

public <M extends org.apache.hadoop.io.Writable> SendMessageChain<I,V,E,M> thenSendToNeighbors(String name,
                                                                                               MessageCombiner<? super I,M> messageCombiner,
                                                                                               FunctionWithVertex<I,V,E,P,M> messageSupplier)

Give previously received message(s) to messageSupplier, and send message it returns to all neighbors of current vertex, and use given messageCombiner to combine messages together.

endReduce

public <S,R extends org.apache.hadoop.io.Writable> Block endReduce(String name,
                                                                   ReduceOperation<S,R> reduceOp,
                                                                   FunctionWithVertex<I,V,E,P,S> valueSupplier,
                                                                   Consumer<R> reducedValueConsumer)

End chain by giving received messages to valueSupplier, to produce value that should be reduced, and consumed on master by reducedValueConsumer.

endReduceWithMaster

public <S,R extends org.apache.hadoop.io.Writable> Block endReduceWithMaster(String name,
                                                                             ReduceOperation<S,R> reduceOp,
                                                                             FunctionWithVertex<I,V,E,P,S> valueSupplier,
                                                                             PairConsumer<R,BlockMasterApi> reducedValueConsumer)

End chain by giving received messages to valueSupplier, to produce value that should be reduced, and consumed on master by reducedValueConsumer.

endConsume

public Block endConsume(ConsumerWithVertex<I,V,E,P> messagesConsumer)

End chain by processing messages received within the last link in the chain.

endCustom

public Block endCustom(Function<SupplierFromVertex<I,V,E,P>,Block> createBlockToAttach)

End chain by providing a function that will produce Block to be attached to the end of current chain, given a supplier of messages received within the last link in the chain.