info.pppc.base.system.plugin

Interface IPacket

All Known Implementing Classes:

IPPacket, Packet

public interface IPacket

A packet is a data container that is used as transfer-unit in packet connectors. It provides setters and getters for packet payload. Note that in most packet implementations, the maximum size of the payload will be limited by the communication technology.

Author:

Marcus Handte

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getPayload() Returns the payload of the packet.
void	setPayload(byte[] payload) Sets the payload of the packet.

Method Detail

getPayload

byte[] getPayload()

Returns the payload of the packet. This method is typically used to receive the data from a packet that has been passed to the receive method of a packet connector. If the payload is not known because the packet has no payload yet, the method will return null.

Returns:

The payload of the packet or null if the payload is undefined.

setPayload

void setPayload(byte[] payload)
                throws java.lang.IndexOutOfBoundsException

Sets the payload of the packet. This method is typically used before a packet is sent with the send method of the packet connector.

Parameters:

payload - The payload of the packet.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the payload does not fit into the length of the packet.