io.pkts.packet.impl

Class TransportPacketImpl

java.lang.Object

io.pkts.packet.impl.AbstractPacket

io.pkts.packet.impl.TransportPacketImpl

All Implemented Interfaces:

Packet, TransportPacket, Cloneable

Direct Known Subclasses:

SctpPacketImpl, TcpPacketImpl, UdpPacketImpl

public abstract class TransportPacketImpl
extends AbstractPacket
implements TransportPacket

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransportPacketImpl(IPPacket parent, Protocol protocol, Buffer headers, Buffer payload)

Method Summary

Modifier and Type	Method and Description
abstract TransportPacket	clone()
long	getArrivalTime() The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970).
int	getDestinationPort()
Packet	getNextPacket() Get the next frame, or null if there is none.
IPPacket	getParentPacket() Almost all packets have a parent, which is the encapsulating protocol.
int	getSourcePort()
boolean	isSCTP()
boolean	isTCP()
boolean	isUDP()
void	setDestinationPort(int port)
void	setSourcePort(int port)
void	verify() Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow.

Methods inherited from class io.pkts.packet.impl.AbstractPacket

checkParent, getName, getPacket, getPayload, getProtocol, hasProtocol, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.TransportPacket

getHeaderLength

Methods inherited from interface io.pkts.packet.Packet

getName, getPacket, getPayload, getProtocol, hasProtocol, write, write

Constructor Detail

TransportPacketImpl

protected TransportPacketImpl(IPPacket parent,
                              Protocol protocol,
                              Buffer headers,
                              Buffer payload)

Method Detail

isUDP

public boolean isUDP()

Specified by:

isUDP in interface TransportPacket

isTCP

public boolean isTCP()

Specified by:

isTCP in interface TransportPacket

isSCTP

public boolean isSCTP()

Specified by:

isSCTP in interface TransportPacket

getSourcePort

public final int getSourcePort()

Specified by:

getSourcePort in interface TransportPacket

setSourcePort

public final void setSourcePort(int port)

Specified by:

setSourcePort in interface TransportPacket

getDestinationPort

public final int getDestinationPort()

Specified by:

getDestinationPort in interface TransportPacket

setDestinationPort

public final void setDestinationPort(int port)

Specified by:

setDestinationPort in interface TransportPacket

verify

public void verify()

Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow. E.g., if this happens to be a SIP packet, then it will check if it has the mandatory headers etc. Some simpler packets, such as the IPPacket, hardly does anything in this method but more complex protocols such as SIP (once again), HTTP etc can spend quite some time verifying everything, which is why you don't want to do it unless you really have to. In general, yajpcap has the philosophy of "assume that everything is ok until things blow up and then deal with it"

Specified by:

verify in interface Packet

Overrides:

verify in class AbstractPacket

getArrivalTime

public final long getArrivalTime()

Description copied from interface: Packet

The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970). Note, since this returns with microseconds precision (which may or may not be relevant depending on the hardware on which the packet was captured on) and you wish to format this arrival time into a more human readable format you could use the SimpleDateFormat but it can only handle milliseconds precision (you will have to write your own date formatter if you want microseconds). Here is a snippet illustrating how to turn the arrival time of the packet into a human readable date

 Packet p = ...;
 SimpleDateFormat formatter = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss.SSS");
 Date date = new Date(p.getArrivalTime() / 1000);
 System.out.println("Arrival time: " + formatter.format(date));
 

Note how an integer devision is performed on the arrival time to "cut off" the microseconds from the time stamp

Specified by:

getArrivalTime in interface Packet

Returns:

the arrival time of the packet in microseconds since the start of the epoch

clone

public abstract TransportPacket clone()

Specified by:

clone in interface Packet

Specified by:

clone in interface TransportPacket

Specified by:

clone in class AbstractPacket

getNextPacket

public Packet getNextPacket()
                     throws IOException

Description copied from interface: Packet

Get the next frame, or null if there is none. Note, if there isn't another frame but there is still raw data within this frame, it only means that we didn't recognize the payload.

Specified by:

getNextPacket in interface Packet

Returns:

Throws:

IOException

getParentPacket

public IPPacket getParentPacket()

Description copied from interface: Packet

Almost all packets have a parent, which is the encapsulating protocol. E.g., the parent of a SipPacket is typically a TransportPacket such as UDPPacket or a TCPPacket. The parent of a TransportPacket is usually a IPPacket and so on.

Specified by:

getParentPacket in interface Packet

Specified by:

getParentPacket in interface TransportPacket

Overrides:

getParentPacket in class AbstractPacket

Returns: