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

end, header, middle

Constructor Summary

Constructors

Constructor and Description
ShutdownPacket(byte[] spassword)
ShutdownPacket(byte[] spassword, byte restart)

Method Summary

Modifier and Type	Method and Description
void	createEnd(LocalChannelReference lcr) Prepare the End buffer
static ShutdownPacket	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[]	getKey()
byte	getType()
boolean	isRestart()
String	toString()

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

clear, getLocalPacket, 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

createEnd

public void createEnd(LocalChannelReference lcr)
               throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the End buffer

Specified by:

createEnd in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

createHeader

public void createHeader(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the Header buffer

Specified by:

createHeader in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

createMiddle

public void createMiddle(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the Middle buffer

Specified by:

createMiddle in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

toString

public String toString()

Specified by:

toString in class AbstractLocalPacket

getType

public byte getType()

Specified by:

getType in class AbstractLocalPacket

Returns:

the type of Packet

getKey

public byte[] getKey()

Returns:

the key

isRestart

public boolean isRestart()