org.apache.giraph.comm

Class SendVertexIdDataCache<I extends org.apache.hadoop.io.WritableComparable,T,B extends VertexIdData<I,T>>

java.lang.Object

org.apache.giraph.comm.SendDataCache<B>

org.apache.giraph.comm.SendVertexIdDataCache<I,T,B>

Type Parameters:

I - Vertex id

T - Data

B - Specialization of VertexIdData for T

Direct Known Subclasses:

SendEdgeCache, SendMessageCache

@NotThreadSafe
public abstract class SendVertexIdDataCache<I extends org.apache.hadoop.io.WritableComparable,T,B extends VertexIdData<I,T>>
extends SendDataCache<B>

An abstract structure for caching data indexed by vertex id, to be sent to workers in bulk. Not thread-safe.

Constructor Summary

Constructors

Constructor and Description
SendVertexIdDataCache(ImmutableClassesGiraphConfiguration conf, CentralizedServiceWorker<?,?,?> serviceWorker, int maxRequestSize, float additionalRequestSize) Constructor.

Method Summary

Modifier and Type	Method and Description
int	addData(WorkerInfo workerInfo, int partitionId, byte[] serializedId, int idPos, T data) This method is similar to the method above, but use a serialized id to replace original I type destVertexId.
int	addData(WorkerInfo workerInfo, int partitionId, I destVertexId, T data) Add data to the cache.
abstract B	createVertexIdData() Create a new VertexIdData specialized for the use case.

Methods inherited from class org.apache.giraph.comm.SendDataCache

getConf, getData, getInitialBufferSize, getNumWorkers, getSendWorkerInitialBufferSize, getServiceWorker, getWorkerPartitions, incrDataSize, removeAllData, removeWorkerData, setData

Methods inherited from class java.lang.Object

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

Constructor Detail

SendVertexIdDataCache

public SendVertexIdDataCache(ImmutableClassesGiraphConfiguration conf,
                             CentralizedServiceWorker<?,?,?> serviceWorker,
                             int maxRequestSize,
                             float additionalRequestSize)

Constructor.

Parameters:

conf - Giraph configuration

serviceWorker - Service worker

maxRequestSize - Maximum request size (in bytes)

additionalRequestSize - Additional request size (expressed as a ratio of the average request size)

Method Detail

createVertexIdData

public abstract B createVertexIdData()

Create a new VertexIdData specialized for the use case.

Returns:

A new instance of VertexIdData

addData

public int addData(WorkerInfo workerInfo,
                   int partitionId,
                   I destVertexId,
                   T data)

Add data to the cache.

Parameters:

workerInfo - the remote worker destination

partitionId - the remote Partition this message belongs to

destVertexId - vertex id that is ultimate destination

data - Data to send to remote worker

Returns:

Size of messages for the worker.

addData

public int addData(WorkerInfo workerInfo,
                   int partitionId,
                   byte[] serializedId,
                   int idPos,
                   T data)

This method is similar to the method above, but use a serialized id to replace original I type destVertexId.

Parameters:

workerInfo - The remote worker destination

partitionId - The remote Partition this message belongs to

serializedId - The byte array to store the serialized target vertex id

idPos - The length of bytes of serialized id in the byte array above

data - Data to send to remote worker

Returns:

The number of bytes added to the target worker