io.pkts.framer

Interface Framer<P extends Packet,T extends Packet>

All Known Implementing Classes:

EthernetFramer, IPv4Framer, IPv6Framer, PcapFramer, RTCPFramer, RTPFramer, SctpFramer, SIPFramer, SllFramer, TCPFramer, UDPFramer

public interface Framer<P extends Packet,T extends Packet>

Simple interface for framers.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
boolean	accept(Buffer data) Check whether the supplied data could be framed into a frame of this type.
T	frame(P parent, Buffer buffer) Ask the framer to frame the buffer into a packet.
Protocol	getProtocol()

Method Detail

getProtocol

Protocol getProtocol()

Returns:

the protocol this framer is capable of framing

frame

T frame(P parent,
        Buffer buffer)
 throws IOException,
        FramingException

Ask the framer to frame the buffer into a packet. Note that the Packet has not been parsed, just framed.

Parameters:

parent - the parent frame or null if the frame doesn't have one.

buffer - the buffer containing all the raw data

Returns:

a new frame

Throws:

IOException - in case something goes wrong when reading data from the buffer

FramingException - in case the data in buffer can't be parsed by the framer

accept

boolean accept(Buffer data)
        throws IOException

Check whether the supplied data could be framed into a frame of this type. Typically, a Framer will read a few bytes in an effort to figure out if the incoming data may be something it recognizes. E.g., a HTTP Framer could check if the first bytes match "GET", "POST", "PUT" and "DELETE" if if so assume that the payload indeed is HTTP and therefore return true. Of course, you may never really know until you actually have parsed the entire body but this method should return quick and if turns out that the data isn't what it thought, throw an exception and the framework will take care of it.

Parameters:

data - the data to check whether it could be a frame of this type

Returns:

true if the data indeed could be of this framer type, false if not

Throws:

IOException