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 static byte[]	EMPTY_ARRAY
protected io.netty.buffer.ByteBuf	end
protected io.netty.buffer.ByteBuf	global
protected io.netty.buffer.ByteBuf	header
protected static int	LOCAL_HEADER_SIZE
protected io.netty.buffer.ByteBuf	middle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLocalPacket()

Method Summary

Modifier and Type	Method and Description
void	clear()
abstract void	createAllBuffers(LocalChannelReference lcr, int networkHeader) Prepare the 3 buffers Header, Middle and End
void	createEnd(LocalChannelReference lcr) Prepare the End buffer
void	createHeader(LocalChannelReference lcr) Prepare the Header buffer
void	createMiddle(LocalChannelReference lcr) Prepare the Middle buffer
io.netty.buffer.ByteBuf	getLocalPacket(LocalChannelReference lcr)
io.netty.buffer.ByteBuf	getLocalPacketForNetworkPacket(LocalChannelReference lcr, NetworkPacket packet)
abstract byte	getType()
abstract boolean	hasGlobalBuffer()
void	retain()
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

protected static final byte[] EMPTY_ARRAY

LOCAL_HEADER_SIZE

protected static final int LOCAL_HEADER_SIZE

See Also:

Constant Field Values

header

protected io.netty.buffer.ByteBuf header

middle

protected io.netty.buffer.ByteBuf middle

end

protected io.netty.buffer.ByteBuf end

global

protected io.netty.buffer.ByteBuf global

Constructor Detail

AbstractLocalPacket

protected AbstractLocalPacket()

Method Detail

hasGlobalBuffer

public abstract boolean hasGlobalBuffer()

Returns:

True if all buffers fit in one piece

createAllBuffers

public abstract void createAllBuffers(LocalChannelReference lcr,
                                      int networkHeader)
                               throws OpenR66ProtocolPacketException

Prepare the 3 buffers Header, Middle and End

Throws:

OpenR66ProtocolPacketException

createHeader

public void createHeader(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Prepare the Header buffer

Throws:

OpenR66ProtocolPacketException

createMiddle

public void createMiddle(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Prepare the Middle buffer

Throws:

OpenR66ProtocolPacketException

createEnd

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

Parameters:

lcr - the LocalChannelReference in use

Returns:

the ByteBuf as LocalPacket

Throws:

OpenR66ProtocolPacketException

getLocalPacketForNetworkPacket

public final io.netty.buffer.ByteBuf getLocalPacketForNetworkPacket(LocalChannelReference lcr,
                                                                    NetworkPacket packet)
                                                             throws OpenR66ProtocolPacketException

Parameters:

lcr - the LocalChannelReference in use

Returns:

the ByteBuf as LocalPacket

Throws:

OpenR66ProtocolPacketException

clear

public void clear()

retain

public final void retain()