openr66.protocol.localhandler.packet
Class AbstractLocalPacket

java.lang.Object
  openr66.protocol.localhandler.packet.AbstractLocalPacket

Direct Known Subclasses:

AuthentPacket, BusinessRequestPacket, ConnectionErrorPacket, DataPacket, EndRequestPacket, EndTransferPacket, ErrorPacket, InformationPacket, KeepAlivePacket, NoOpPacket, RequestPacket, ShutdownPacket, StartupPacket, TestPacket, ValidPacket

public abstract class AbstractLocalPacket
extends Object

This class represents Abstract Packet with its header, middle and end parts. A Packet is composed of one Header part, one Middle part (data), and one End part. Header: length field (4 bytes) = Middle length field (4 bytes), End length field (4 bytes), type field (1 byte), ...
Middle: (Middle length field bytes)
End: (End length field bytes) = code status field (4 bytes), ...

Author:

frederic bregier

Field Summary

protected org.jboss.netty.buffer.ChannelBuffer	end
protected org.jboss.netty.buffer.ChannelBuffer	header
protected org.jboss.netty.buffer.ChannelBuffer	middle

Constructor Summary

AbstractLocalPacket()

AbstractLocalPacket(org.jboss.netty.buffer.ChannelBuffer header, org.jboss.netty.buffer.ChannelBuffer middle, org.jboss.netty.buffer.ChannelBuffer end)

Method Summary

abstract void	createEnd() Prepare the End buffer
abstract void	createHeader() Prepare the Header buffer
abstract void	createMiddle() Prepare the Middle buffer
org.jboss.netty.buffer.ChannelBuffer	getLocalPacket()
abstract byte	getType()
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

header

protected org.jboss.netty.buffer.ChannelBuffer header

middle

protected org.jboss.netty.buffer.ChannelBuffer middle

end

protected org.jboss.netty.buffer.ChannelBuffer end

Constructor Detail

AbstractLocalPacket

public AbstractLocalPacket(org.jboss.netty.buffer.ChannelBuffer header,
                           org.jboss.netty.buffer.ChannelBuffer middle,
                           org.jboss.netty.buffer.ChannelBuffer end)

AbstractLocalPacket

public AbstractLocalPacket()

Method Detail

createHeader

public abstract void createHeader()
                           throws OpenR66ProtocolPacketException

Prepare the Header buffer

Throws:

OpenR66ProtocolPacketException

createMiddle

public abstract void createMiddle()
                           throws OpenR66ProtocolPacketException

Prepare the Middle buffer

Throws:

OpenR66ProtocolPacketException

createEnd

public abstract void createEnd()
                        throws OpenR66ProtocolPacketException

Prepare the End buffer

Throws:

OpenR66ProtocolPacketException

getType

public abstract byte getType()

Returns:

the type of Packet

toString

public abstract String toString()

Overrides:

toString in class Object

getLocalPacket

public org.jboss.netty.buffer.ChannelBuffer getLocalPacket()
                                                    throws OpenR66ProtocolPacketException

Returns:

the ChannelBuffer as LocalPacket

Throws:

OpenR66ProtocolPacketException