io.pkts.frame

Interface Frame

All Superinterfaces:

Externalizable, Serializable

All Known Implementing Classes:

AbstractFrame

public interface Frame
extends Externalizable

A frame in the OSI model typically have some headers and then a payload/data section. The payload may itself be another frame and so on. A Frame can be asked to fully parse its data in order to produce a Packet.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
void	frameAll() Frame all protocols within this frame.
long	getArrivalTime()
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.
Packet	parse() A frame has not fully parsed the data but only enough so it can find the boundary between the headers and its payload.
void	write(OutputStream out)

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

hasProtocol

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.

Parameters:

p -

Returns:

Throws:

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

getProtocol

Protocol getProtocol()

Get the protocol of this frame.

Returns:

getFrame

Frame getFrame(Protocol p)
        throws IOException

Find the frame for protocol p.

Parameters:

p -

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

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.

Throws:

IOException

getName

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.

Returns:

getNextFrame

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.

Returns:

Throws:

IOException

getPayload

Buffer getPayload()

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

Returns:

getArrivalTime

long getArrivalTime()

parse

Packet parse()
      throws PacketParseException

A frame has not fully parsed the data but only enough so it can find the boundary between the headers and its payload. Each type of frame can be parsed into a specific Packet, which will examine all the headers etc more closely to make sure that the data conforms to whatever protocol it is dealing with.

Returns:

Throws:

PacketParseException - TODO

getPcapGlobalHeader

PcapGlobalHeader getPcapGlobalHeader()

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.

Returns:

write

void write(OutputStream out)
    throws IOException

Throws:

IOException