io.pkts.packet

Interface IPPacket

All Superinterfaces:

Cloneable, Packet

All Known Subinterfaces:

IPv4Packet, IPv6Packet

All Known Implementing Classes:

IPv4PacketImpl, IPv6PacketImpl

public interface IPPacket
extends Packet, Cloneable

Represents a packet from the Network Layer (layer 3). Actually, to be completely honest, the model implemented (at least so far) is more geared towards what is commonly referred to as the Internet Layer and is strictly speaking not quite the same as the Network Layer as specified by the OSI model. However, until it becomes an issue this little "issue" is going to be ignored and for now the Network Layer is equal to the Internet Layer. The current version of pkts.io is focused on IP anyway so...

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
IPPacket	clone()
String	getDestinationIP() Convenience method for returning the destination IP in a more human readable form.
short	getFragmentOffset() The fragment offset field, measured in units of eight-byte blocks, is 13 bits long and specifies the offset of a particular fragment relative to the beginning of the original unfragmented IP datagram.
int	getHeaderLength() Get the length of the IP headers (in bytes)
int	getIdentification() Note, this should be treated as a unsigned short.
byte[]	getRawDestinationIP() Get the raw bytes, either 4 or 16, that represent the destination IP address.
byte[]	getRawSourceIP() Get the raw bytes, either 4 or 16, that represent the source IP.
String	getSourceIP() Convenience method for returning the source IP in a more human readable form.
int	getTotalIPLength() This 16-bit field defines the entire packet (fragment) size, including header and data, in bytes.
int	getVersion() The IP version (4 or 6)
boolean	isFragmented()
void	setDestinationIP(String destinationIP) Set the destination IP of this IPPacket.
void	setSourceIP(String sourceIp) Set the source IP of this IPPacket.

Methods inherited from interface io.pkts.packet.Packet

getArrivalTime, getName, getNextPacket, getPacket, getParentPacket, getPayload, getProtocol, hasProtocol, verify, write, write

Method Detail

getSourceIP

String getSourceIP()

Convenience method for returning the source IP in a more human readable form.

Returns:

getRawSourceIP

byte[] getRawSourceIP()

Get the raw bytes, either 4 or 16, that represent the source IP.

Returns:

setSourceIP

void setSourceIP(String sourceIp)

Set the source IP of this IPPacket.

Parameters:

sourceIp -

getDestinationIP

String getDestinationIP()

Convenience method for returning the destination IP in a more human readable form.

Returns:

getRawDestinationIP

byte[] getRawDestinationIP()

Get the raw bytes, either 4 or 16, that represent the destination IP address.

Returns:

setDestinationIP

void setDestinationIP(String destinationIP)

Set the destination IP of this IPPacket.

getTotalIPLength

int getTotalIPLength()

This 16-bit field defines the entire packet (fragment) size, including header and data, in bytes. The minimum-length packet is 20 bytes (20-byte header + 0 bytes data) and the maximum is 65,535 bytes — the maximum value of a 16-bit word. The largest datagram that any host is required to be able to reassemble is 576 bytes, but most modern hosts handle much larger packets. Sometimes subnetworks impose further restrictions on the packet size, in which case datagrams must be fragmented. Fragmentation is handled in either the host or router in IPv4. (source: http://en.wikipedia.org/wiki/IPv4)

Returns:

clone

IPPacket clone()

Specified by:

clone in interface Packet

getVersion

int getVersion()

The IP version (4 or 6)

Returns:

getHeaderLength

int getHeaderLength()

Get the length of the IP headers (in bytes)

Returns:

getIdentification

int getIdentification()

Note, this should be treated as a unsigned short. This field is an identification field and is primarily used for uniquely identifying fragments of an original IP datagram. Some experimental work has suggested using the ID field for other purposes, such as for adding packet-tracing information to help trace datagrams with spoofed source addresses (source http://en.wikipedia.org/wiki/IPv4)

Returns:

isFragmented

boolean isFragmented()

Returns:

getFragmentOffset

short getFragmentOffset()

The fragment offset field, measured in units of eight-byte blocks, is 13 bits long and specifies the offset of a particular fragment relative to the beginning of the original unfragmented IP datagram. The first fragment has an offset of zero. This allows a maximum offset of (213 – 1) × 8 = 65,528 bytes, which would exceed the maximum IP packet length of 65,535 bytes with the header length included (65,528 + 20 = 65,548 bytes). (source http://en.wikipedia.org/wiki/IPv4)

Returns: