io.pkts.framer

Class TCPFramer

java.lang.Object

io.pkts.framer.TCPFramer

All Implemented Interfaces:

Framer<IPPacket,TCPPacket>

public final class TCPFramer
extends java.lang.Object
implements Framer<IPPacket,TCPPacket>

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
TCPFramer()

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.
TCPPacket	frame(IPPacket parent, Buffer buffer) Ask the framer to frame the buffer into a packet.
Protocol	getProtocol()

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPFramer

public TCPFramer()

Method Detail

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in interface Framer<IPPacket,TCPPacket>

Returns:

the protocol this framer is capable of framing

frame

public TCPPacket frame(IPPacket parent,
                       Buffer buffer)
                throws java.io.IOException

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

Specified by:

frame in interface Framer<IPPacket,TCPPacket>

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:

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

accept

public boolean accept(Buffer data)
               throws java.io.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.

Specified by:

accept in interface Framer<IPPacket,TCPPacket>

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:

java.io.IOException