org.apache.giraph.block_app.framework.api

Interface BlockWorkerSendApi<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>

Type Parameters:

I - Vertex id type

V - Vertex value type

E - Edge value type

M - Message type

All Superinterfaces:

AggregatorUsage, BlockApi, BlockConfApi, BlockOutputApi, BlockWorkerApi<I>, StatusReporter, WorkerAggregatorUsage, WorkerIndexUsage<I>, WorkerReduceUsage

public interface BlockWorkerSendApi<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>
extends BlockWorkerApi<I>, WorkerAggregatorUsage, WorkerReduceUsage

Block computation API available for worker send methods. Interface to the Computation methods.

Method Summary

Modifier and Type	Method and Description
void	addEdgeRequest(I sourceVertexId, Edge<I,E> edge) Request to add an edge of a vertex in the graph (processed just prior to the next receive phase)
void	addVertexRequest(I id, V value) Sends a request to create a vertex that will be available in the receive phase.
void	addVertexRequest(I id, V value, OutEdges<I,E> edges) Sends a request to create a vertex that will be available in the receive phase.
ImmutableClassesGiraphConfiguration<I,V,E>	getConf() Return the configuration used by this object.
void	removeEdgesRequest(I sourceVertexId, I targetVertexId) Request to remove all edges from a given source vertex to a given target vertex (processed just prior to the next receive phase).
void	removeVertexRequest(I vertexId) Request to remove a vertex from the graph (applied just prior to the next receive phase).
void	sendMessage(I id, M message) Send a message to a vertex id.
void	sendMessageToAllEdges(Vertex<I,V,E> vertex, M message) Send a message to all edges.
void	sendMessageToMultipleEdges(Iterator<I> vertexIdIterator, M message) Send a message to multiple target vertex ids in the iterator.

Methods inherited from interface org.apache.giraph.block_app.framework.api.BlockApi

getTotalNumEdges, getTotalNumVertices, getWorkerCount

Methods inherited from interface org.apache.giraph.block_app.framework.api.BlockOutputApi

getOutputDesc, getWriter

Methods inherited from interface org.apache.giraph.worker.WorkerIndexUsage

getMyWorkerIndex, getWorkerCount, getWorkerForVertex

Methods inherited from interface org.apache.giraph.block_app.framework.api.StatusReporter

getCounter, progress, setStatus

Methods inherited from interface org.apache.giraph.worker.WorkerAggregatorUsage

aggregate

Methods inherited from interface org.apache.giraph.aggregators.AggregatorUsage

getAggregatedValue

Methods inherited from interface org.apache.giraph.worker.WorkerReduceUsage

reduce, reduceMerge

Method Detail

getConf

ImmutableClassesGiraphConfiguration<I,V,E> getConf()

Description copied from interface: BlockConfApi

Return the configuration used by this object.

Specified by:

getConf in interface BlockConfApi

Specified by:

getConf in interface BlockWorkerApi<I extends org.apache.hadoop.io.WritableComparable>

Returns:

Set configuration

sendMessage

void sendMessage(I id,
                 M message)

Send a message to a vertex id.

Parameters:

id - Vertex id to send the message to

message - Message data to send

sendMessageToAllEdges

void sendMessageToAllEdges(Vertex<I,V,E> vertex,
                           M message)

Send a message to all edges.

Parameters:

vertex - Vertex whose edges to send the message to.

message - Message sent to all edges.

sendMessageToMultipleEdges

void sendMessageToMultipleEdges(Iterator<I> vertexIdIterator,
                                M message)

Send a message to multiple target vertex ids in the iterator.

Parameters:

vertexIdIterator - An iterator to multiple target vertex ids.

message - Message sent to all targets in the iterator.

addVertexRequest

void addVertexRequest(I id,
                      V value,
                      OutEdges<I,E> edges)

Sends a request to create a vertex that will be available in the receive phase.

Parameters:

id - Vertex id

value - Vertex value

edges - Initial edges

addVertexRequest

void addVertexRequest(I id,
                      V value)

Sends a request to create a vertex that will be available in the receive phase.

Parameters:

id - Vertex id

value - Vertex value

removeVertexRequest

void removeVertexRequest(I vertexId)

Request to remove a vertex from the graph (applied just prior to the next receive phase).

Parameters:

vertexId - Id of the vertex to be removed.

addEdgeRequest

void addEdgeRequest(I sourceVertexId,
                    Edge<I,E> edge)

Request to add an edge of a vertex in the graph (processed just prior to the next receive phase)

Parameters:

sourceVertexId - Source vertex id of edge

edge - Edge to add

removeEdgesRequest

void removeEdgesRequest(I sourceVertexId,
                        I targetVertexId)

Request to remove all edges from a given source vertex to a given target vertex (processed just prior to the next receive phase).

Parameters:

sourceVertexId - Source vertex id

targetVertexId - Target vertex id