io.pkts.packet.impl

Class MACPacketImpl

java.lang.Object

io.pkts.packet.impl.AbstractPacket

io.pkts.packet.impl.MACPacketImpl

All Implemented Interfaces:

MACPacket, Packet, java.lang.Cloneable

public final class MACPacketImpl
extends AbstractPacket
implements MACPacket

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
MACPacketImpl(Protocol protocol, PCapPacket parent, Buffer headers, Buffer payload) Construct a new MACPacket based on the supplied headers.

Method Summary

Modifier and Type	Method and Description
MACPacket	clone()
static MACPacketImpl	create(PCapPacket parent, Buffer headers) Creates a new MACPacketImpl and it assumes ethernet II and it does not check whether or not the ethertype is a known type.
long	getArrivalTime() The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970).
java.lang.String	getDestinationMacAddress()
IPPacket	getNextPacket() Get the next frame, or null if there is none.
Protocol	getNextProtocol()
java.lang.String	getSourceMacAddress()
void	setDestinationMacAddress(java.lang.String macAddress)
void	setSourceMacAddress(java.lang.String macAddress) Set the MAC address of this MACPacket.
static java.lang.String	toHexString(Buffer buffer, int start, int length)
java.lang.String	toString()
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.
void	write(java.io.OutputStream out, Buffer payload) Writes this packet to the OutputStream with the supplied payload.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.Packet

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

Constructor Detail

MACPacketImpl

public MACPacketImpl(Protocol protocol,
                     PCapPacket parent,
                     Buffer headers,
                     Buffer payload)

Construct a new MACPacket based on the supplied headers.

Method Detail

create

public static MACPacketImpl create(PCapPacket parent,
                                   Buffer headers)

Creates a new MACPacketImpl and it assumes ethernet II and it does not check whether or not the ethertype is a known type. This method should only be used by the internal packet creating functions such as the TransportPacketFactoryImpl or the framers.

Parameters:

parent -

headers -

Returns:

getSourceMacAddress

public final java.lang.String getSourceMacAddress()

Specified by:

getSourceMacAddress in interface MACPacket

toHexString

public static java.lang.String toHexString(Buffer buffer,
                                           int start,
                                           int length)
                                    throws java.io.IOException

Throws:

java.io.IOException

getDestinationMacAddress

public final java.lang.String getDestinationMacAddress()

Specified by:

getDestinationMacAddress in interface MACPacket

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getArrivalTime

public 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

write

public void write(java.io.OutputStream out,
                  Buffer payload)
           throws java.io.IOException

Description copied from interface: Packet

Writes this packet to the OutputStream with the supplied payload. You can use this method to e.g. write a raw UDPPacket to the stream with this payload. Note, if the UDPPacket already had a payload it will be ignored so use this method with care.

Specified by:

write in interface Packet

Throws:

java.io.IOException

setSourceMacAddress

public void setSourceMacAddress(java.lang.String macAddress)

Set the MAC address of this MACPacket.

Specified by:

setSourceMacAddress in interface MACPacket

setDestinationMacAddress

public void setDestinationMacAddress(java.lang.String macAddress)

Specified by:

setDestinationMacAddress in interface MACPacket

clone

public MACPacket clone()

Specified by:

clone in interface MACPacket

Specified by:

clone in interface Packet

Specified by:

clone in class AbstractPacket

getNextProtocol

public Protocol getNextProtocol()
                         throws java.io.IOException

Throws:

java.io.IOException

getNextPacket

public IPPacket getNextPacket()
                       throws java.io.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:

java.io.IOException