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

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

Direct Known Subclasses:

PReqBreakpointClear, PReqBreakpointDisable, PReqBreakpointEnable, PReqBreakpointLocation, PReqInitializeDE, PReqModuleAdd, PReqModuleRemove, PReqProcessAttach2, PReqTerminateDE, PReqUnknown, PReqVersion

public abstract class PROTOCOL_Request
extends PROTOCOL_Base

Request packet class

Field Summary

protected int	_request_code
protected int	_total_bytes

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

_byteBuffer, DISPLAYDETAIL

Constructor Summary

protected	PROTOCOL_Request(byte[] inBuffer, PROTOCOL_EngineSession engineSession) All request classes inherit from this class
protected	PROTOCOL_Request(int request_code)

Method Summary

static PROTOCOL_Request	decodeRequestStream(InputStream inputStream, PROTOCOL_EngineSession engineSession) Decodes and returns a request object from an EPDC connection based on the request type
protected int	fixedLen() Return the length of the fixed component
int	getRequestCode() Returns the request code See interface EPDC for request code values
boolean	isSynchronous() True if this request should be sent even when the engine is busy stepping or running Override this for those requests that are synchronous
void	output(OutputStream outputStream) Calculate total bytes, give connection object a chance to write out a packet prefix, then stream out this object.
protected int	varLen() Return the length of the variable component
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

_request_code

protected int _request_code

_total_bytes

protected int _total_bytes

Constructor Detail

PROTOCOL_Request

protected PROTOCOL_Request(byte[] inBuffer,
                           PROTOCOL_EngineSession engineSession)
                    throws IOException

All request classes inherit from this class

Parameters:

engineSession -

Throws:

IOException

PROTOCOL_Request

protected PROTOCOL_Request(int request_code)

Method Detail

decodeRequestStream

public static PROTOCOL_Request decodeRequestStream(InputStream inputStream,
                                                   PROTOCOL_EngineSession engineSession)
                                            throws IOException

Decodes and returns a request object from an EPDC connection based on the request type

Throws:

IOException

output

public final void output(OutputStream outputStream)
                  throws IOException

Calculate total bytes, give connection object a chance to write out a packet prefix, then stream out this object.

Throws:

IOException

fixedLen

protected int fixedLen()

Return the length of the fixed component

Specified by:

fixedLen in class PROTOCOL_Base

varLen

protected int varLen()

Return the length of the variable component

Specified by:

varLen in class PROTOCOL_Base

getRequestCode

public int getRequestCode()

Returns the request code See interface EPDC for request code values

isSynchronous

public boolean isSynchronous()

True if this request should be sent even when the engine is busy stepping or running Override this for those requests that are synchronous

Returns:

boolean

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