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

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

Direct Known Subclasses:

PRepBreakpointLocation, PRepInitializeDE, PRepTypesNumGet, PRepVersion, PROTOCOL_BasicReply

public abstract class PROTOCOL_Reply
extends PROTOCOL_Base

Field Summary

protected int	_message_offset
protected com.ibm.etools.systems.as400.debug.protocol.PStdString	_message_text
protected int	_reply_code
protected int	_return_code
protected int	_total_bytes

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

_byteBuffer, DISPLAYDETAIL

Constructor Summary

protected	PROTOCOL_Reply()
protected	PROTOCOL_Reply(byte[] packetBuffer, DataInputStream dataInputStream, PROTOCOL_EngineSession engineSession) Used to process an incoming reply packet

Method Summary

boolean	anyChanged() returns true if any changed bits are on
static PROTOCOL_Reply	decodeReplyStream(InputStream inputStream, PROTOCOL_EngineSession engineSession) returns a reply object from a buffer based on the reply type default to process the change packets
static PROTOCOL_Reply	decodeReplyStream(InputStream inputStream, PROTOCOL_EngineSession engineSession, boolean processChgPkts) returns a reply object from a buffer based on the reply type
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.
PECPBreakpoint[]	getBreakpointChanges()
String	getMessageText() returns the text of the message if there is any if there is no text then a null string is returned
int	getReplyCode() returns the reply code see ibm.EPDC.EPDC.java for a list of the codes
int	getReturnCode() returns the return code
boolean	isBrkPtChgd()
boolean	isFCTChgd()
boolean	isLogChgd()
boolean	isModuleEntryChgd()
boolean	isMonRegsChgd()
boolean	isMonStackChgd()
boolean	isMonStorChgd()
boolean	isMonVariableChgd()
boolean	isPartChgd()
boolean	isPgmStateChgd()
String	returnCodeString() returns a string that represents the return code
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, getInternalName, 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

Field Detail

_reply_code

protected int _reply_code

_return_code

protected int _return_code

_message_offset

protected int _message_offset

_message_text

protected com.ibm.etools.systems.as400.debug.protocol.PStdString _message_text

_total_bytes

protected int _total_bytes

Constructor Detail

PROTOCOL_Reply

protected PROTOCOL_Reply()

PROTOCOL_Reply

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

Used to process an incoming reply packet

Throws:

IOException

Method Detail

decodeReplyStream

public static PROTOCOL_Reply decodeReplyStream(InputStream inputStream,
                                               PROTOCOL_EngineSession engineSession)
                                        throws IOException

returns a reply object from a buffer based on the reply type default to process the change packets

Throws:

IOException

decodeReplyStream

public static PROTOCOL_Reply decodeReplyStream(InputStream inputStream,
                                               PROTOCOL_EngineSession engineSession,
                                               boolean processChgPkts)
                                        throws IOException

returns a reply object from a buffer based on the reply type

Throws:

IOException

getReplyCode

public int getReplyCode()

returns the reply code see ibm.EPDC.EPDC.java for a list of the codes

getReturnCode

public int getReturnCode()

returns the return code

returnCodeString

public String returnCodeString()

returns a string that represents the return code

getMessageText

public String getMessageText()

returns the text of the message if there is any if there is no text then a null string is returned

anyChanged

public boolean anyChanged()

returns true if any changed bits are on

isPartChgd

public boolean isPartChgd()

isBrkPtChgd

public boolean isBrkPtChgd()

isPgmStateChgd

public boolean isPgmStateChgd()

isMonVariableChgd

public boolean isMonVariableChgd()

isMonStorChgd

public boolean isMonStorChgd()

isMonStackChgd

public boolean isMonStackChgd()

isMonRegsChgd

public boolean isMonRegsChgd()

isModuleEntryChgd

public boolean isModuleEntryChgd()

isFCTChgd

public boolean isFCTChgd()

isLogChgd

public boolean isLogChgd()

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

getBreakpointChanges

public PECPBreakpoint[] getBreakpointChanges()

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