org.waarp.openr66.protocol.localhandler.packet

Class ShutdownPacket

java.lang.Object

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

org.waarp.openr66.protocol.localhandler.packet.ShutdownPacket

public class ShutdownPacket
extends AbstractLocalPacket

Shutdown Message class for packet

1 string: spassword(or key) + 1 byte (optional) to restart (if not null)

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
ShutdownPacket(byte[] spassword)
ShutdownPacket(byte[] spassword, byte restart)

Method Summary

Modifier and Type	Method and Description
void	createAllBuffers(LocalChannelReference lcr, int networkHeader) Prepare the 3 buffers Header, Middle and End
static ShutdownPacket	createFromBuffer(int headerLength, int middleLength, int endLength, io.netty.buffer.ByteBuf buf)
byte[]	getKey()
byte	getType()
boolean	hasGlobalBuffer()
boolean	isRestart()
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

ShutdownPacket

public ShutdownPacket(byte[] spassword)

Parameters:

spassword -

ShutdownPacket

public ShutdownPacket(byte[] spassword,
                      byte restart)

Parameters:

spassword -

restart -

Method Detail

createFromBuffer

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

Parameters:

headerLength -

middleLength -

endLength -

buf -

Returns:

the new ShutdownPacket 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

getKey

public final byte[] getKey()

Returns:

the key

isRestart

public final boolean isRestart()