org.waarp.openr66.protocol.localhandler.packet

Class AbstractLocalPacket

java.lang.Object

org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

Direct Known Subclasses:

AuthentPacket, BlockRequestPacket, BusinessRequestPacket, ConnectionErrorPacket, DataPacket, EndRequestPacket, EndTransferPacket, ErrorPacket, InformationPacket, JsonCommandPacket, 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), ...

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.buffer.ByteBuf	end
protected io.netty.buffer.ByteBuf	header
protected io.netty.buffer.ByteBuf	middle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLocalPacket()
protected	AbstractLocalPacket(io.netty.buffer.ByteBuf header, io.netty.buffer.ByteBuf middle, io.netty.buffer.ByteBuf end)

Method Summary

Modifier and Type	Method and Description
void	clear()
abstract void	createEnd(LocalChannelReference lcr) Prepare the End buffer
abstract void	createHeader(LocalChannelReference lcr) Prepare the Header buffer
abstract void	createMiddle(LocalChannelReference lcr) Prepare the Middle buffer
io.netty.buffer.ByteBuf	getLocalPacket(LocalChannelReference lcr)
abstract byte	getType()
void	retain()
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

header

protected io.netty.buffer.ByteBuf header

middle

protected io.netty.buffer.ByteBuf middle

end

protected io.netty.buffer.ByteBuf end

Constructor Detail

AbstractLocalPacket

protected AbstractLocalPacket(io.netty.buffer.ByteBuf header,
                              io.netty.buffer.ByteBuf middle,
                              io.netty.buffer.ByteBuf end)

AbstractLocalPacket

protected AbstractLocalPacket()

Method Detail

createHeader

public abstract void createHeader(LocalChannelReference lcr)
                           throws OpenR66ProtocolPacketException

Prepare the Header buffer

Throws:

OpenR66ProtocolPacketException

createMiddle

public abstract void createMiddle(LocalChannelReference lcr)
                           throws OpenR66ProtocolPacketException

Prepare the Middle buffer

Throws:

OpenR66ProtocolPacketException

createEnd

public abstract void createEnd(LocalChannelReference lcr)
                        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 io.netty.buffer.ByteBuf getLocalPacket(LocalChannelReference lcr)
                                       throws OpenR66ProtocolPacketException

Parameters:

lcr - the LocalChannelReference in use

Returns:

the ByteBuf as LocalPacket

Throws:

OpenR66ProtocolPacketException

clear

public void clear()

retain

public void retain()