org.waarp.openr66.protocol.localhandler.packet

Class BlockRequestPacket

java.lang.Object

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

org.waarp.openr66.protocol.localhandler.packet.BlockRequestPacket

public class BlockRequestPacket
extends AbstractLocalPacket

Block Request Message class

1 code (byte as 0: unblock, 1:block): block, 1 string: spassword(or 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
BlockRequestPacket(boolean block, byte[] spassword)

Method Summary

Modifier and Type	Method and Description
void	createAllBuffers(LocalChannelReference lcr, int networkHeader) Prepare the 3 buffers Header, Middle and End
static BlockRequestPacket	createFromBuffer(int headerLength, int middleLength, int endLength, io.netty.buffer.ByteBuf buf)
boolean	getBlock()
byte[]	getKey()
byte	getType()
boolean	hasGlobalBuffer()
String	toString()

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

clear, createEnd, createHeader, createMiddle, getLocalPacket, getLocalPacketForNetworkPacket, retain

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockRequestPacket

public BlockRequestPacket(boolean block,
                          byte[] spassword)

Parameters:

block -

spassword -

Method Detail

createFromBuffer

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

Parameters:

headerLength -

middleLength -

endLength -

buf -

Returns:

the new ValidPacket from buffer

Throws:

OpenR66ProtocolPacketException

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

toString

public final String toString()

Specified by:

toString in class AbstractLocalPacket

getType

public final byte getType()

Specified by:

getType in class AbstractLocalPacket

Returns:

the type of Packet

getBlock

public final boolean getBlock()

Returns:

True if the request is to block new requests, else false

getKey

public final byte[] getKey()

Returns:

the key