Home > Class Reference > ENSLIB namespace > %Atelier.v1.XDebugAgent

%Atelier.v1.XDebugAgent

class %Atelier.v1.XDebugAgent extends %CSP.WebSocket

This class serves as a debug agent for debugging cache processes It receives client debugging commands, sends then to the debug target, gets responses, and sends them back to the client. The implementation is based on the XDEBUG DBGP protocol used by the eclipse DLTK http://xdebug.org/docs-dbgp.php

Property Inventory

Method Inventory

Parameters

parameter CLASS = 2;
This is the CLASS context for variable display in the IDE
parameter DOMAIN = %XDEBUG;
Parameter for Localization
parameter EXITSTATE = 1;
parameter IDLE = OnIdle;
parameter NULLSTATE = 0;
parameter PRIVATE = 0;
This is the PRIVATE context for variable display in the IDE
parameter PUBLIC = 1;
This is the PUBLIC context for variable display in the IDE
parameter SECURITYRESOURCE = %Development;
Require development resource
parameter STOP = 2;
parameter TIMEOUT = 0.1;

Properties

property Attached as %Boolean [ InitialExpression = 0 ];
This holds the attached flag
Property methods: AttachedDisplayToLogical(), AttachedGet(), AttachedIsValid(), AttachedLogicalToDisplay(), AttachedNormalize(), AttachedSet()
property BreakPoints as %String [ MultiDimensional ];
Breakpoints
Property methods: BreakPointsDisplayToLogical(), BreakPointsGet(), BreakPointsIsValid(), BreakPointsLogicalToDisplay(), BreakPointsLogicalToOdbc(), BreakPointsNormalize(), BreakPointsSet()
property Command as %String [ MultiDimensional ];
This holds the current command
Property methods: CommandDisplayToLogical(), CommandGet(), CommandIsValid(), CommandLogicalToDisplay(), CommandLogicalToOdbc(), CommandNormalize(), CommandSet()
property ContinuationCmdIssued as %Boolean [ InitialExpression = 0 ];
This holds the Continuation command issued flag
Property methods: ContinuationCmdIssuedDisplayToLogical(), ContinuationCmdIssuedGet(), ContinuationCmdIssuedIsValid(), ContinuationCmdIssuedLogicalToDisplay(), ContinuationCmdIssuedNormalize(), ContinuationCmdIssuedSet()
property Debug as %Debugger.System;
This holds the debugger instance
Property methods: DebugGet(), DebugGetSwizzled(), DebugIsValid(), DebugNewObject(), DebugSet(), DebugTargetDisplayToLogical(), DebugTargetGet(), DebugTargetIsValid(), DebugTargetLogicalToDisplay(), DebugTargetLogicalToOdbc(), DebugTargetNormalize(), DebugTargetSet()
property DebugTarget as %String;
This holds the debug_target (passsed to us by set_feature)
Property methods: DebugTargetDisplayToLogical(), DebugTargetGet(), DebugTargetIsValid(), DebugTargetLogicalToDisplay(), DebugTargetLogicalToOdbc(), DebugTargetNormalize(), DebugTargetSet()
property DeviceList as %List;
This holds the device list for $System.Socket.Select
Property methods: DeviceListGet(), DeviceListIsValid(), DeviceListLogicalToOdbc(), DeviceListOdbcToLogical(), DeviceListSet()
property Features as %String [ MultiDimensional ];
This holds the values of the features set by the IDE
Property methods: FeaturesDisplayToLogical(), FeaturesGet(), FeaturesIsValid(), FeaturesLogicalToDisplay(), FeaturesLogicalToOdbc(), FeaturesNormalize(), FeaturesSet()
property FirstRunCommandSeen as %Boolean [ InitialExpression = 0 ];
This holds the first run command flag
Property methods: FirstRunCommandSeenDisplayToLogical(), FirstRunCommandSeenGet(), FirstRunCommandSeenIsValid(), FirstRunCommandSeenLogicalToDisplay(), FirstRunCommandSeenNormalize(), FirstRunCommandSeenSet()
property LastContinuationCmd as %String;
This holds the last 'continuation' command issued Continuation commands are 'run','step_into','step_over','step_out' 'stop' and 'detach'. We need to record this so that the appropriate status message can be reported to the client when a breakpoint is hit or the program ends.
Property methods: LastContinuationCmdDisplayToLogical(), LastContinuationCmdGet(), LastContinuationCmdIsValid(), LastContinuationCmdLogicalToDisplay(), LastContinuationCmdLogicalToOdbc(), LastContinuationCmdNormalize(), LastContinuationCmdSet()
property Launched as %Boolean [ InitialExpression = 0 ];
This holds the launched flag
Property methods: LaunchedDisplayToLogical(), LaunchedGet(), LaunchedIsValid(), LaunchedLogicalToDisplay(), LaunchedNormalize(), LaunchedSet()
property NextState as %String [ InitialExpression = ..#NULLSTATE ];