com.ibm.etools.systems.as400.debug.protocol
Class PROTOCOL_ChangePacket

java.lang.Object
  com.ibm.etools.systems.as400.debug.protocol.PROTOCOL_Base
      com.ibm.etools.systems.as400.debug.protocol.PROTOCOL_ChangePacket

Direct Known Subclasses:

PBkptChangePacket

public abstract class PROTOCOL_ChangePacket
extends PROTOCOL_Base

Field Summary

Fields inherited from class com.ibm.etools.systems.as400.debug.protocol.PROTOCOL_Base

_byteBuffer, DISPLAYDETAIL

Constructor Summary

protected

PROTOCOL_ChangePacket(byte[] packetBuffer, DataInputStream dataInputStream, PROTOCOL_EngineSession engineSession, PROTOCOL_Reply reply) This represents the changed info packets that follow reply packets Constructor for creating a change packet from an incoming reply.

Method Summary

static PROTOCOL_ChangePacket	decodeChangePacketStream(InputStream inputStream, PROTOCOL_Reply reply, PROTOCOL_EngineSession engineSession) Takes buffer from a connection and decodes a change packet Used on the client side of EPDC connection to decode change packet created by engine side of EPDC connection.
protected int	fixedLen() Return the total length of the fixed component including any base fixed length Each reply/request must implement this to return the "fixed" portion of their protocol.
PROTOCOL_Reply	getAssociatedReply() Get the reply that this change packet is associated with
String	getInternalName() This is for internal use only.
protected int	varLen() Return the total length of the variable component including any *base* variable length Return the length of the variable component Each reply/request must implement this to return the length of the variable portion of its protocol e.g.
void	writeFormattedEPDC(DataOutputStream dataOutputStream, byte formatFlags) Write to the output stream an XML formatted representation of this EPDC class NOTE: This method should be implemented in all EPDC classes

Methods inherited from class com.ibm.etools.systems.as400.debug.protocol.PROTOCOL_Base

bytesAvailable, dumpEPDC, getByteBuffer, getDataInputStream, getEPDCEngineSession, getEPDCVersion, getOffset, getPlatformIdentifier, intAsBytes, markOffset, posBuffer, readChar, readExtString, readInt, readOffset, readShort, readStdString, setEPDCEngineSession, skipBytes, totalBytes, totalBytes, writeChar, writeInt, writeOffset, writeOffsetOrZero, writeShort

Methods inherited from class java.lang.Object

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

Constructor Detail

PROTOCOL_ChangePacket

protected PROTOCOL_ChangePacket(byte[] packetBuffer,
                                DataInputStream dataInputStream,
                                PROTOCOL_EngineSession engineSession,
                                PROTOCOL_Reply reply)
                         throws IOException

This represents the changed info packets that follow reply packets Constructor for creating a change packet from an incoming reply.

Throws:

IOException

Method Detail

decodeChangePacketStream

public static PROTOCOL_ChangePacket decodeChangePacketStream(InputStream inputStream,
                                                             PROTOCOL_Reply reply,
                                                             PROTOCOL_EngineSession engineSession)
                                                      throws IOException

Takes buffer from a connection and decodes a change packet Used on the client side of EPDC connection to decode change packet created by engine side of EPDC connection.

Throws:

IOException

getInternalName

public String getInternalName()

Description copied from class: PROTOCOL_Base

This is for internal use only. The default will return the name of the class. Where it is meaningful this should overridden

Overrides:

getInternalName in class PROTOCOL_Base

Returns:

internal string name for the request or reply

getAssociatedReply

public PROTOCOL_Reply getAssociatedReply()

Get the reply that this change packet is associated with

Returns:

the reply that this change packet was added to

fixedLen

protected final int fixedLen()

Description copied from class: PROTOCOL_Base

Return the total length of the fixed component including any base fixed length Each reply/request must implement this to return the "fixed" portion of their protocol. e.g. this.fixedLen() + super.fixedLen()

Specified by:

fixedLen in class PROTOCOL_Base

varLen

protected final int varLen()

Description copied from class: PROTOCOL_Base

Return the total length of the variable component including any *base* variable length Return the length of the variable component Each reply/request must implement this to return the length of the variable portion of its protocol e.g. this.varLen() + super.varLen()

Specified by:

varLen in class PROTOCOL_Base

writeFormattedEPDC

public void writeFormattedEPDC(DataOutputStream dataOutputStream,
                               byte formatFlags)

Description copied from class: PROTOCOL_Base

Write to the output stream an XML formatted representation of this EPDC class NOTE: This method should be implemented in all EPDC classes

Specified by:

writeFormattedEPDC in class PROTOCOL_Base