protocolP2P

Class Payload

java.lang.Object

protocolP2P.Payload

Direct Known Subclasses:

Denied, DiscoverRequest, DiscoverResponse, FileList, FilePart, HashRequest, HashResponse, LoadRequest, RatioRequest, RatioResponse, Register, SizeRequest, SizeResponse, Unregister, UpdateRatio

public class Payload
extends java.lang.Object

Representation of payload. If payload has a size, use subclasses instead.

Version:

1.0

Author:

Louis Royer, Flavien Haas, JS Auge

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	PAYLOAD_SIZE_POSITION
protected static int	PAYLOAD_START_POSITION
protected RequestResponseCode	requestResponseCode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Payload(byte[] packet) Constructor used to create a Payload (when no more specific subclasses exists) using packet as parameter.
	Payload(RequestResponseCode requestResponseCode) Consructor used to create Payload with a payload size of zero using a RRCode.

Method Summary

Modifier and Type	Method and Description
private void	checkRequestResponseCode() Used to check RRCode used is compatible with this class use, or if a more specific subclass is required.
protected static int	getPayloadSize(byte[] packet) Get payload’s size from a Packet.
RequestResponseCode	getRequestResponseCode() RRCode getter.
protected static void	setPayloadSize(int size, byte[] packet) Set payload’s size in a Packet.
protected byte[]	toPacket() Returns a byte[] containing Packet with padding.

Methods inherited from class java.lang.Object

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

Field Detail

requestResponseCode

protected RequestResponseCode requestResponseCode

PAYLOAD_SIZE_POSITION

protected static final int PAYLOAD_SIZE_POSITION

See Also:

Constant Field Values

PAYLOAD_START_POSITION

protected static final int PAYLOAD_START_POSITION

See Also:

Constant Field Values

Constructor Detail

Payload

public Payload(RequestResponseCode requestResponseCode)
        throws InternalError

Consructor used to create Payload with a payload size of zero using a RRCode.

Parameters:

requestResponseCode - Request/Response code associated with the payload

Throws:

InternalError

Payload

protected Payload(byte[] packet)
           throws SizeError,
                  ProtocolError,
                  InternalError,
                  TransmissionError

Constructor used to create a Payload (when no more specific subclasses exists) using packet as parameter. If payload size is not empty, using subclass is required.

Parameters:

packet - the full packet received

Throws:

ProtocolError

InternalError

TransmissionError

SizeError

Method Detail

checkRequestResponseCode

private void checkRequestResponseCode()
                               throws InternalError

Used to check RRCode used is compatible with this class use, or if a more specific subclass is required.

Throws:

InternalError

toPacket

protected byte[] toPacket()
                   throws InternalError

Returns a byte[] containing Packet with padding. This Packet is still incomplete and should not be send directly. ProtocolP2PPacket will use this method to generate the complete Packet.

Returns:

Packet with padding

Throws:

InternalError

setPayloadSize

protected static void setPayloadSize(int size,
                                     byte[] packet)
                              throws InternalError

Set payload’s size in a Packet.

Parameters:

size - integer representing payload size

packet - Packet to be completed

Throws:

InternalError

getPayloadSize

protected static int getPayloadSize(byte[] packet)
                             throws SizeError

Get payload’s size from a Packet.

Parameters:

packet - the full Packet received

Returns:

integer representing payload size

Throws:

SizeError

getRequestResponseCode

public RequestResponseCode getRequestResponseCode()

RRCode getter.

Returns:

Request/Response code