protocolP2P

Class ProtocolP2PPacket<T extends Payload>

java.lang.Object

protocolP2P.ProtocolP2PPacket<T>

Direct Known Subclasses:

ProtocolP2PPacketTCP, ProtocolP2PPacketUDP

public abstract class ProtocolP2PPacket<T extends Payload>
extends java.lang.Object

Representation of packet.

Version:

1.0

Author:

Louis Royer, Flavien Haas, JS Auge

Field Summary

Fields

Modifier and Type	Field and Description
protected Payload	payload
private static byte	PROTOCOL_VERSION
protected byte	version
protected static int	VERSION_POSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolP2PPacket(byte[] packet) Construct a packet from byte[], subclasses must overwrite this constructor.
protected	ProtocolP2PPacket(java.lang.Object socket) Receive a request, subclasses must overwrite this constructor.
	ProtocolP2PPacket(T payload) Constructor with payload parameter (typically used when sending Packet).

Method Summary

Modifier and Type	Method and Description
protected void	checkProtocolVersion() Used to check protocol version when a Packet is constructed from bytes[].
abstract HostItem	getHostItem() Get hostItem of the sender
Payload	getPayload() Returns Payload associated with the Packet.
abstract ProtocolP2PPacket<?>	receiveResponse() Receive a response
abstract void	sendRequest(java.lang.Object socket) Send a request
abstract <U extends ProtocolP2PPacket<?>> void	sendResponse(U response) Send a response

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_VERSION

private static final byte PROTOCOL_VERSION

See Also:

Constant Field Values

VERSION_POSITION

protected static final int VERSION_POSITION

See Also:

Constant Field Values

version

protected byte version

payload

protected Payload payload

Constructor Detail

ProtocolP2PPacket

public ProtocolP2PPacket(T payload)

Constructor with payload parameter (typically used when sending Packet).

Parameters:

payload - the payload associated with the Packet to send

ProtocolP2PPacket

protected ProtocolP2PPacket(java.lang.Object socket)
                     throws TransmissionError,
                            ProtocolError,
                            VersionError,
                            InternalError,
                            SizeError,
                            java.io.IOException,
                            SocketClosed

Receive a request, subclasses must overwrite this constructor.

Parameters:

socket - socket used to get the request

Throws:

TransmissionError

ProtocolError

VersionError

InternalError

SizeError

java.io.IOException

SocketClosed

ProtocolP2PPacket

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

Construct a packet from byte[], subclasses must overwrite this constructor.

Parameters:

packet - Packet received

Throws:

TransmissionError

ProtocolError

VersionError

InternalError

SizeError

Method Detail

sendRequest

public abstract void sendRequest(java.lang.Object socket)
                          throws InternalError,
                                 java.io.IOException,
                                 SocketClosed

Send a request

Parameters:

socket - Socket used to send packet.

Throws:

InternalError

java.io.IOException

SocketClosed

sendResponse

public abstract <U extends ProtocolP2PPacket<?>> void sendResponse(U response)
                                                            throws InternalError,
                                                                   java.io.IOException,
                                                                   SocketClosed

Send a response

Parameters:

response - Response to send.

Throws:

InternalError

java.io.IOException

SocketClosed

getHostItem

public abstract HostItem getHostItem()
                              throws InternalError

Get hostItem of the sender

Returns:

hostItem of the sender

Throws:

InternalError

receiveResponse

public abstract ProtocolP2PPacket<?> receiveResponse()
                                              throws EmptyFile,
                                                     NotFound,
                                                     NotATracker,
                                                     EmptyDirectory,
                                                     InternalRemoteError,
                                                     VersionRemoteError,
                                                     ProtocolRemoteError,
                                                     TransmissionError,
                                                     ProtocolError,
                                                     VersionError,
                                                     InternalError,
                                                     SizeError,
                                                     java.io.IOException,
                                                     SocketClosed,
                                                     UnknownHost

Receive a response

Throws:

EmptyFile

NotFound

NotATracker

EmptyDirectory

InternalRemoteError

VersionRemoteError

ProtocolRemoteError

TransmissionError

ProtocolError

VersionError

InternalError

SizeError

java.io.IOException

SocketClosed

UnknownHost

getPayload

public Payload getPayload()

Returns Payload associated with the Packet.

Returns:

payload associated with the Packet.

checkProtocolVersion

protected void checkProtocolVersion()
                             throws VersionError

Used to check protocol version when a Packet is constructed from bytes[].

Throws:

VersionError