org.waarp.openr66.protocol.localhandler.packet

Class DataPacket

java.lang.Object

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

org.waarp.openr66.protocol.localhandler.packet.DataPacket

public class DataPacket
extends AbstractLocalPacket

Data packet

header = packetRank middle = data end = key

Field Summary

Fields inherited from class org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

EMPTY_ARRAY, end, global, header, LOCAL_HEADER_SIZE, middle

Constructor Summary

Constructors

Constructor and Description
DataPacket(int packetRank, byte[] data, int length, byte[] key)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	createAllBuffers(LocalChannelReference lcr, int networkHeader) Prepare the 3 buffers Header, Middle and End
void	createByteBufFromRecv(R66Session session) Transform the DataPacket to have a byte array instead of ByteBuf
void	createEnd(LocalChannelReference lcr) Prepare the End buffer
static DataPacket	createFromBuffer(int headerLength, int middleLength, int endLength, io.netty.buffer.ByteBuf buf)
void	createHeader(LocalChannelReference lcr) Prepare the Header buffer
void	createMiddle(LocalChannelReference lcr) Prepare the Middle buffer
byte[]	getData()
byte[]	getKey()
int	getLengthPacket()
int	getPacketRank()
byte	getType()
boolean	hasGlobalBuffer()
boolean	isKeyValid(FilesystemBasedDigest digestBlock, FilesystemBasedDigest digestGlobal, FilesystemBasedDigest digestLocal)
String	toString()
void	updateFromCompressionCodec(byte[] data, int length) When using compression/decompression, data can be changed

Methods inherited from class org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

getLocalPacket, getLocalPacketForNetworkPacket, retain

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPacket

public DataPacket(int packetRank,
                  byte[] data,
                  int length,
                  byte[] key)

Parameters:

packetRank -

data -

length -

key -

Method Detail

createFromBuffer

public static DataPacket createFromBuffer(int headerLength,
                                          int middleLength,
                                          int endLength,
                                          io.netty.buffer.ByteBuf buf)
                                   throws OpenR66ProtocolPacketException

Parameters:

headerLength -

middleLength -

endLength -

buf -

Returns:

the new DataPacket from buffer

Throws:

OpenR66ProtocolPacketException

updateFromCompressionCodec

public final void updateFromCompressionCodec(byte[] data,
                                             int length)

When using compression/decompression, data can be changed

Parameters:

data -

length -

hasGlobalBuffer

public final boolean hasGlobalBuffer()

Specified by:

hasGlobalBuffer in class AbstractLocalPacket

Returns:

True if all buffers fit in one piece

createAllBuffers

public final void createAllBuffers(LocalChannelReference lcr,
                                   int networkHeader)

Description copied from class: AbstractLocalPacket

Prepare the 3 buffers Header, Middle and End

Specified by:

createAllBuffers in class AbstractLocalPacket

createEnd

public final void createEnd(LocalChannelReference lcr)

Description copied from class: AbstractLocalPacket

Prepare the End buffer

Overrides:

createEnd in class AbstractLocalPacket

createHeader

public final void createHeader(LocalChannelReference lcr)

Description copied from class: AbstractLocalPacket

Prepare the Header buffer

Overrides:

createHeader in class AbstractLocalPacket

createMiddle

public final void createMiddle(LocalChannelReference lcr)

Description copied from class: AbstractLocalPacket

Prepare the Middle buffer

Overrides:

createMiddle in class AbstractLocalPacket

getType

public final byte getType()

Specified by:

getType in class AbstractLocalPacket

Returns:

the type of Packet

toString

public final String toString()

Specified by:

toString in class AbstractLocalPacket

getPacketRank

public final int getPacketRank()

Returns:

the packetRank

getLengthPacket

public final int getLengthPacket()

Returns:

the lengthPacket

createByteBufFromRecv

public final void createByteBufFromRecv(R66Session session)

Transform the DataPacket to have a byte array instead of ByteBuf

Parameters:

session - to allow to get reusable buffer

getData

public final byte[] getData()

Returns:

the data

getKey

public final byte[] getKey()

Returns:

the key

isKeyValid

public final boolean isKeyValid(FilesystemBasedDigest digestBlock,
                                FilesystemBasedDigest digestGlobal,
                                FilesystemBasedDigest digestLocal)

Returns:

True if the Hashed key is valid (or no key is set)

clear

public final void clear()

Overrides:

clear in class AbstractLocalPacket