Rational Developer for i
7.5.0

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

java.lang.Object
  extended by com.ibm.etools.systems.as400.debug.protocol.PROTOCOL_EngineSession

public class PROTOCOL_EngineSession
extends Object

This class is a structure of EPDC information that contains information about the current EPDC session


Field Summary
 short _debugEngineID
           
 short _debugEnginePlatformID
           
 int _defaultSettings
           
 PRepGetExceptions[] _exceptionsInfo
           
 PFunctCustTable _functCustomTable
           
 PRepGetLanguages[] _languageInfo
           
 int _processDetachAction
           
 PRepTypesNumGet _repInfo
           
 PRepGetViews[] _viewInfo
           
 
Constructor Summary
PROTOCOL_EngineSession()
           
 
Method Summary
 int getConnectionTimeout()
           
protected  OutputStream[] getDumpOutputStreams()
          Gets the output streams to be used for dumping EPDC
 String getEngineExtensionID()
          Returns the engine extension ID
 IFormattedString getFormattingClass()
          Returns the formattingClass.
 int getNegotiatedEPDCVersion()
          Get the EPDC level that both front and backend have agreed to work with
 boolean is390()
           
 boolean isEPDCDumpEnabled()
          Returns current state of dump EPDC
 boolean isIntel()
           
 boolean isiSeries()
           
 boolean isTPF()
           
 boolean reverseStackEntries()
          There is an inconsistency in the order that engines return stackframes Top stackframe first is the prefered way.
 void setConnectionTimeout(int i)
          Connection timeout setting (0==indefinite)
 void setDumpEPDCEnabled(boolean dumpEPDC)
          Sets the dumpEPDC.
 void setDumpOutputStream(OutputStream[] dumpOutputStreams)
          Sets the dumpOutputStreams.
 void setEngineExtensionID(String engineExtensionID)
          Sets the engine extension ID
 void setFormattingClass(IFormattedString formattingClass)
          Sets the formattingClass.
 void setNegotiatedEPDCVersion(int level)
          Set the negotiated EPDC level.
 boolean useStackEntryIndex()
          Use this test to determine if a stackentry's index should be used instead of the stackentry ID In EPDC 308 and before there is inconsisency in how the stackentry id field is used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_debugEngineID

public short _debugEngineID

_debugEnginePlatformID

public short _debugEnginePlatformID

_defaultSettings

public int _defaultSettings

_processDetachAction

public int _processDetachAction

_viewInfo

public PRepGetViews[] _viewInfo

_languageInfo

public PRepGetLanguages[] _languageInfo

_exceptionsInfo

public PRepGetExceptions[] _exceptionsInfo

_functCustomTable

public PFunctCustTable _functCustomTable

_repInfo

public PRepTypesNumGet _repInfo
Constructor Detail

PROTOCOL_EngineSession

public PROTOCOL_EngineSession()
Method Detail

isEPDCDumpEnabled

public boolean isEPDCDumpEnabled()
Returns current state of dump EPDC

Returns:
true if EPDC should be dumped

setDumpEPDCEnabled

public void setDumpEPDCEnabled(boolean dumpEPDC)
Sets the dumpEPDC.

Parameters:
dumpEPDC - The dumpEPDC to set

getDumpOutputStreams

protected OutputStream[] getDumpOutputStreams()
Gets the output streams to be used for dumping EPDC

Returns:
Returns an array of OutputStreams

setDumpOutputStream

public void setDumpOutputStream(OutputStream[] dumpOutputStreams)
Sets the dumpOutputStreams.

Parameters:
dumpOutputStream - The dumpOutputStream to set

getEngineExtensionID

public String getEngineExtensionID()
Returns the engine extension ID

Returns:
String

setEngineExtensionID

public void setEngineExtensionID(String engineExtensionID)
Sets the engine extension ID

Parameters:
formatStringClassID - The engine ID

getFormattingClass

public IFormattedString getFormattingClass()
Returns the formattingClass.

Returns:
IFormattedString

setFormattingClass

public void setFormattingClass(IFormattedString formattingClass)
Sets the formattingClass.

Parameters:
formattingClass - The formattingClass to set

is390

public boolean is390()

isTPF

public boolean isTPF()

isiSeries

public boolean isiSeries()

isIntel

public boolean isIntel()

getNegotiatedEPDCVersion

public int getNegotiatedEPDCVersion()
Get the EPDC level that both front and backend have agreed to work with

Returns:
EPDC version

setNegotiatedEPDCVersion

public void setNegotiatedEPDCVersion(int level)
Set the negotiated EPDC level. This is the level that both the front and the back have agreed to use

Parameters:
negotiated - level

useStackEntryIndex

public boolean useStackEntryIndex()
Use this test to determine if a stackentry's index should be used instead of the stackentry ID In EPDC 308 and before there is inconsisency in how the stackentry id field is used. Engines based on DT390 sent the stackframes in the opposite order (top stackframe first) and therefore the ID and the index of the stackentry didn't match. This test can be used to determine which to use, the index or the stack ID In 309 this will be standardized to match the EPDC spec

Returns:
true if stackentry index should be used.

reverseStackEntries

public boolean reverseStackEntries()
There is an inconsistency in the order that engines return stackframes Top stackframe first is the prefered way. This method will return true if the engine returns stackframes top last.

Returns:
true if the stackframes are reversed

getConnectionTimeout

public int getConnectionTimeout()
Returns:
the current timeout setting

setConnectionTimeout

public void setConnectionTimeout(int i)
Connection timeout setting (0==indefinite)

Parameters:
set - the timeout setting

Rational Developer for i
7.5.0

Copyright 2009 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.