com.sshtools.j2ssh.connection
Class SshMsgChannelClose

java.lang.Object
  |
  +--com.sshtools.j2ssh.transport.SshMessage
        |
        +--com.sshtools.j2ssh.connection.SshMsgChannelClose

public class SshMsgChannelClose
extends SshMessage

Implements the SSH_MSG_CHANNEL_CLOSE message.

Version:
1.0
Author:
Lee David Painter ( lee@sshtools.com )

Field Summary
protected static int SSH_MSG_CHANNEL_CLOSE
          The message id
 
Constructor Summary
SshMsgChannelClose()
          Constructor for the SshMsgChannelClose object
SshMsgChannelClose(long recipientChannel)
          Constructor for the SshMsgChannelClose object
 
Method Summary
protected  void constructByteArray(ByteArrayWriter baw)
           Abstract method implementation to construct a byte array containing the message data.
protected  void constructMessage(ByteArrayReader bar)
           Abstract method implementation to contstruct the message from a byte array.
 java.lang.String getMessageName()
           Gets the message name for debugging.
 long getRecipientChannel()
           Gets the recipient channel id.
 
Methods inherited from class com.sshtools.j2ssh.transport.SshMessage
fromByteArray, getMessageId, toByteArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SSH_MSG_CHANNEL_CLOSE

protected static final int SSH_MSG_CHANNEL_CLOSE
The message id

See Also:
Constant Field Values
Constructor Detail

SshMsgChannelClose

public SshMsgChannelClose(long recipientChannel)
Constructor for the SshMsgChannelClose object

Parameters:
recipientChannel - The recipient channel id

SshMsgChannelClose

public SshMsgChannelClose()
Constructor for the SshMsgChannelClose object

Method Detail

getMessageName

public java.lang.String getMessageName()

Gets the message name for debugging.

Specified by:
getMessageName in class SshMessage
Returns:

getRecipientChannel

public long getRecipientChannel()

Gets the recipient channel id.

Returns:
The recipientChannel id

constructMessage

protected void constructMessage(ByteArrayReader bar)
                         throws InvalidMessageException

Abstract method implementation to contstruct the message from a byte array.

Specified by:
constructMessage in class SshMessage
Parameters:
bar - The byte array being read
Throws:
InvalidMessageException - Thrown if the data is invalid

constructByteArray

protected void constructByteArray(ByteArrayWriter baw)
                           throws InvalidMessageException

Abstract method implementation to construct a byte array containing the message data.

Specified by:
constructByteArray in class SshMessage
Parameters:
baw - The byte array being written
Throws:
InvalidMessageException - Thrown if the data cannot be written


Copyright © 2002 Sshtools.com. All Rights Reserved.