io.pkts.frame

Class AbstractFrame

java.lang.Object

io.pkts.frame.AbstractFrame

All Implemented Interfaces:

Frame, Externalizable, Serializable

public abstract class AbstractFrame
extends Object
implements Frame

Author:

jonas@jonasborjesson.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractFrame(FramerManager framerManager, PcapGlobalHeader header, Protocol p, Buffer payload)

Method Summary

Modifier and Type	Method and Description
void	frameAll() Frame all protocols within this frame.
protected abstract Frame	framePayload(FramerManager framerManager, Buffer payload) Each implementing frame needs to figure out how to frame its payload.
Frame	getFrame(Protocol p) Find the frame for protocol p.
String	getName() Get the name of the frame.
Frame	getNextFrame() Get the next frame, or null if there is none.
Buffer	getPayload() Get the payload of the frame.
PcapGlobalHeader	getPcapGlobalHeader() Each Frame was captured in a pcap that had this PcapGlobalHeader.
Protocol	getProtocol() Get the protocol of this frame.
boolean	hasProtocol(Protocol p) Check whether this frame contains a particular protocol.
void	readExternal(ObjectInput in)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.frame.Frame

getArrivalTime, parse, write

Methods inherited from interface java.io.Externalizable

writeExternal

Constructor Detail

AbstractFrame

public AbstractFrame(FramerManager framerManager,
                     PcapGlobalHeader header,
                     Protocol p,
                     Buffer payload)

Method Detail

hasProtocol

public final boolean hasProtocol(Protocol p)
                          throws IOException

Check whether this frame contains a particular protocol. This will cause the frame to examine all the containing frames to check whether they are indeed the protocol the user asked for.

Specified by:

hasProtocol in interface Frame

Returns:

Throws:

IOException - in case something goes wrong when framing the rest of the protocol stack

getProtocol

public final Protocol getProtocol()

Get the protocol of this frame.

Specified by:

getProtocol in interface Frame

Returns:

getFrame

public final Frame getFrame(Protocol p)
                     throws IOException

Find the frame for protocol p.

Specified by:

getFrame in interface Frame

Returns:

the frame that encapsulates the protocol or null if this protocol doesn't exist

Throws:

IOException - in case something goes wrong when framing the rest of the protocol stack

frameAll

public final void frameAll()
                    throws IOException

Frame all protocols within this frame. Typically, once a particular frame has been framed, it will not continue down its payload to figure out what other frames may potentially be contained in the payload. Eveyrhing is done lazily.

Specified by:

frameAll in interface Frame

Throws:

IOException

getName

public final String getName()

Get the name of the frame. Wireshark will give you a short description of all the known protocols within its "super" frame. E.g., if you "click" on the Pcap Frame it will have a field called "protocols in frame" and will display something like "eth:ip:udp:sip:sdp", this function will return a short name like that.

Specified by:

getName in interface Frame

Returns:

getNextFrame

public final Frame getNextFrame()
                         throws IOException

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:

getNextFrame in interface Frame

Returns:

Throws:

IOException

getPayload

public final Buffer getPayload()

Get the payload of the frame. If null, then this frame doesn't have any payload

Specified by:

getPayload in interface Frame

Returns:

getPcapGlobalHeader

public PcapGlobalHeader getPcapGlobalHeader()

Description copied from interface: Frame

Each Frame was captured in a pcap that had this PcapGlobalHeader. Using this header you can create a new PcapOutputStream and then write this Frame to the output stream without having to worry about which byte order etc this Frame is encoded in.

Specified by:

getPcapGlobalHeader in interface Frame

Returns:

framePayload

protected abstract Frame framePayload(FramerManager framerManager,
                                      Buffer payload)
                               throws IOException

Each implementing frame needs to figure out how to frame its payload.

Parameters:

payload -

Returns:

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException