org.apache.giraph.comm.requests

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

java.lang.Object

org.apache.giraph.comm.requests.WritableRequest<I,V,E>

Type Parameters:

I - Vertex id

V - Vertex data

E - Edge data

All Implemented Interfaces:

GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>, org.apache.hadoop.io.Writable

Direct Known Subclasses:

AddressesAndPartitionsRequest, AskForInputSplitRequest, ByteArrayRequest, PartitionStatsRequest, ReplyWithInputSplitRequest, SaslCompleteRequest, SaslTokenMessageRequest, SendPartitionCurrentMessagesRequest, SendPartitionMutationsRequest, SendResumeRequest, SendVertexRequest, SendWorkerDataRequest, SendWorkerOneMessageToManyRequest, SendWorkerToWorkerMessageRequest, SendWorkerVerticesRequest

public abstract class WritableRequest<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends Object
implements org.apache.hadoop.io.Writable, ImmutableClassesGiraphConfigurable<I,V,E>

Interface for requests to implement

Field Summary

Fields

Modifier and Type	Field and Description
protected ImmutableClassesGiraphConfiguration<I,V,E>	conf Configuration
static int	UNKNOWN_SIZE Value to use when size of the request in serialized form is not known or too expensive to calculate

Constructor Summary

Constructors

Constructor and Description
WritableRequest()

Method Summary

Modifier and Type	Method and Description
int	getClientId()
ImmutableClassesGiraphConfiguration<I,V,E>	getConf() Return the configuration used by this object.
long	getRequestId()
int	getSerializedSize() Get the size of the request in serialized form.
abstract RequestType	getType() Get the type of the request
void	readFields(DataInput input)
void	setClientId(int clientId)
void	setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf) Set the configuration to be used by this object.
void	setRequestId(long requestId)
void	write(DataOutput output)

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_SIZE

public static final int UNKNOWN_SIZE

Value to use when size of the request in serialized form is not known or too expensive to calculate

See Also:

Constant Field Values

conf

protected ImmutableClassesGiraphConfiguration<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable> conf

Configuration

Constructor Detail

WritableRequest

public WritableRequest()

Method Detail

getClientId

public int getClientId()

setClientId

public void setClientId(int clientId)

getRequestId

public long getRequestId()

setRequestId

public void setRequestId(long requestId)

getSerializedSize

public int getSerializedSize()

Get the size of the request in serialized form. The number returned by this function can't be less than the actual size - if the size can't be calculated correctly return WritableRequest.UNKNOWN_SIZE.

Returns:

The size (in bytes) of serialized request, or WritableRequest.UNKNOWN_SIZE if the size is not known or too expensive to calculate.

getType

public abstract RequestType getType()

Get the type of the request

Returns:

Request type

getConf

public final ImmutableClassesGiraphConfiguration<I,V,E> getConf()

Description copied from interface: ImmutableClassesGiraphConfigurable

Return the configuration used by this object.

Specified by:

getConf in interface ImmutableClassesGiraphConfigurable<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

Set configuration

setConf

public final void setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

setConf in interface GiraphConfigurationSettable<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

conf - Set configuration

readFields

public final void readFields(DataInput input)
                      throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

write

public final void write(DataOutput output)
                 throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException