Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'docs/TCF Service - Run Control.html')
-rw-r--r--docs/TCF Service - Run Control.html120
1 files changed, 60 insertions, 60 deletions
diff --git a/docs/TCF Service - Run Control.html b/docs/TCF Service - Run Control.html
index fd5adccd5..55583a8c6 100644
--- a/docs/TCF Service - Run Control.html
+++ b/docs/TCF Service - Run Control.html
@@ -36,7 +36,7 @@ see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
context is in a particular state. For example, if single step command arrives when
context is running, it does not wait until it stops, but returns an error. If a command
successfully resumed a context, it does not wait until instruction pointer reaches
-desired destination from client point of view the command execution ends right after
+desired destination &ndash; from client point of view the command execution ends right after
context was resumed. Various stepping commands can leave a context running in a special
mode, which is different from normal execution, for example, it can leave temporary
breakpoints to suspend the context when control reaches a particular place. Such execution
@@ -47,7 +47,7 @@ why a context is suspended by listening to events.</p>
<h3><a name='CmdGetContext'>Get Context</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl getContext <i>&lt;string: context ID&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; getContext &bull; <i>&lt;string: context ID&gt;</i> &bull;
</font></b></pre>
<p>The command retrieves context properties for given context ID.
@@ -63,11 +63,11 @@ attributes and functionality, which is relevant to that service.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i> <i>&lt;context data&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;context data&gt;</i> &bull;
<i>&lt;context data&gt;</i>
- <font face=Wingdings></font> null
- <font face=Wingdings></font> <i>&lt;object: context properties&gt;</i>
+ &rArr; null
+ &rArr; <i>&lt;object: context properties&gt;</i>
</font></b></pre>
<p>Context data object is collection of context properties. It should, at least, contain member
@@ -115,12 +115,12 @@ contextChanged event to notify changes in context data.</p>
<h3><a name='CmdGetChildren'>Get Children</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl getChildren <i>&lt;string: parent context ID&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; getChildren &bull; <i>&lt;string: parent context ID&gt;</i> &bull;
</font></b></pre>
<p>The command requests list of execution contexts available for run control commands.</p>
-<p>Parent context ID can be null to retrieve top level of the hierarchy, can be one
+<p>Parent context ID can be null &ndash; to retrieve top level of the hierarchy, can be one
of context IDs retrieved by previous getChildren commands, or it can be obtained from another service.
Contexts hierarchy can be simple plain list or it can form a tree. It is up to target agent developers to
choose layout that is most descriptive for a given target.</p>
@@ -128,21 +128,21 @@ choose layout that is most descriptive for a given target.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i> <i>&lt;array of context IDs&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;array of context IDs&gt;</i> &bull;
<i>&lt;array of context IDs&gt;</i>
- <font face=Wingdings></font> null
- <font face=Wingdings></font> [ <i>&lt;context ID list&gt;</i> ]
+ &rArr; null
+ &rArr; [ <i>&lt;context ID list&gt;</i> ]
<i>&lt;context ID list&gt;</i>
- <font face=Wingdings></font> <i>&lt;string: context ID&gt;</i>
- <font face=Wingdings></font> <i>&lt;context ID list&gt;</i> , <i>&lt;string: context ID&gt;</i>
+ &rArr; <i>&lt;string: context ID&gt;</i>
+ &rArr; <i>&lt;context ID list&gt;</i> , <i>&lt;string: context ID&gt;</i>
</font></b></pre>
<h3><a name='CmdSuspend'>Suspend</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl suspend <i>&lt;string: context ID&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; suspend &bull; <i>&lt;string: context ID&gt;</i> &bull;
</font></b></pre>
<p>The command suspends execution of given context. The command should fail if CanSuspend property of the context is false.
@@ -152,13 +152,13 @@ can be suspended.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>
<h3><a name='CmdResume'>Resume</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl resume <i>&lt;string: context ID&gt;</i> <i>&lt;int: mode&gt;</i> <i>&lt;int: count&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; resume &bull; <i>&lt;string: context ID&gt;</i> &bull; <i>&lt;int: mode&gt;</i> &bull; <i>&lt;int: count&gt;</i> &bull;
</font></b></pre>
<p>The command resumes execution of given context. The command should fail if CanResume
@@ -211,13 +211,13 @@ to context's children. Only contexts with HasState = true can be resumed.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>
<h3><a name='CmdGetState'>Get State</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl getState <i>&lt;string: context ID&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; getState &bull; <i>&lt;string: context ID&gt;</i> &bull;
</font></b></pre>
<p>The command retrieves current state of the context. The command should fail if HasState property of
@@ -226,12 +226,12 @@ the context is false.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i> <i>&lt;boolean: suspended&gt;</i>
- <i>&lt;int: PC&gt;</i> <i>&lt;string: last state change reason&gt;</i> <i>&lt;state data&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;boolean: suspended&gt;</i> &bull;
+ <i>&lt;int: PC&gt;</i> &bull; <i>&lt;string: last state change reason&gt;</i> &bull; <i>&lt;state data&gt;</i> &bull;
<i>&lt;state data&gt;</i>
- <font face=Wingdings></font> null
- <font face=Wingdings></font> <i>&lt;object: context state properties&gt;</i>
+ &rArr; null
+ &rArr; <i>&lt;object: context state properties&gt;</i>
</font></b></pre>
<p>State change reason can be any text, but if it is one of predefined strings,
@@ -254,7 +254,7 @@ Definition of state properties depends on a target.</p>
<h3><a name='CmdTerminate'>Terminate</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
-C <i>&lt;token&gt;</i> RunControl terminate <i>&lt;string: context ID&gt;</i>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; terminate &bull; <i>&lt;string: context ID&gt;</i> &bull;
</font></b></pre>
<p>The command terminates execution of given context. The command should fail if CanTerminate
@@ -263,37 +263,37 @@ property of the context is false.</p>
<p>Result message:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
-R <i>&lt;token&gt;</i> <i>&lt;error report&gt;</i>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>
<h2><a name='Events'>Events</a></h2>
<pre><b><font face="Courier New" size=2 color=#333399>
-E RunControl contextAdded <i>&lt;array of context data&gt;</i>
+E &bull; RunControl &bull; contextAdded &bull; <i>&lt;array of context data&gt;</i> &bull;
-E RunControl contextChanged <i>&lt;array of context data&gt;</i>
+E &bull; RunControl &bull; contextChanged &bull; <i>&lt;array of context data&gt;</i> &bull;
-E RunControl contextRemoved <i>&lt;array of context IDs&gt;</i>
+E &bull; RunControl &bull; contextRemoved &bull; <i>&lt;array of context IDs&gt;</i> &bull;
-E RunControl contextSuspended <i>&lt;string: context ID&gt;</i> <i>&lt;int: PC&gt;</i>
- <i>&lt;string: reason&gt;</i> <i>&lt;state data&gt;</i>
+E &bull; RunControl &bull; contextSuspended &bull; <i>&lt;string: context ID&gt;</i> &bull; <i>&lt;int: PC&gt;</i> &bull;
+ <i>&lt;string: reason&gt;</i> &bull; <i>&lt;state data&gt;</i> &bull;
-E RunControl contextResumed <i>&lt;string: context ID&gt;</i>
+E &bull; RunControl &bull; contextResumed &bull; <i>&lt;string: context ID&gt;</i> &bull;
-E RunControl contextException <i>&lt;string: context ID&gt;</i> <i>&lt;string: description&gt;</i>
+E &bull; RunControl &bull; contextException &bull; <i>&lt;string: context ID&gt;</i> &bull; <i>&lt;string: description&gt;</i> &bull;
-E RunControl containerSuspended <i>&lt;string: context ID&gt;</i> <i>&lt;int: PC&gt;</i>
- <i>&lt;string: reason&gt;</i> <i>&lt;state data&gt;</i> <i>&lt;array of context IDs&gt;</i>
+E &bull; RunControl &bull; containerSuspended &bull; <i>&lt;string: context ID&gt;</i> &bull; <i>&lt;int: PC&gt;</i> &bull;
+ <i>&lt;string: reason&gt;</i> &bull; <i>&lt;state data&gt;</i> &bull; <i>&lt;array of context IDs&gt;</i> &bull;
-E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
+E &bull; RunControl &bull; containerResumed &bull; <i>&lt;array of context IDs&gt;</i> &bull;
<i>&lt;array of context data&gt;</i>
- <font face=Wingdings></font> null
- <font face=Wingdings></font> [ <i>&lt;context data list&gt;</i> ]
+ &rArr; null
+ &rArr; [ <i>&lt;context data list&gt;</i> ]
<i>&lt;context data list&gt;</i>
- <font face=Wingdings></font> <i>&lt;object: context data&gt;</i>
- <font face=Wingdings></font> <i>&lt;context data list&gt;</i> , <i>&lt;object: context data&gt;</i>
+ &rArr; <i>&lt;object: context data&gt;</i>
+ &rArr; <i>&lt;context data list&gt;</i> , <i>&lt;object: context data&gt;</i>
</font></b></pre>
<dl>
@@ -381,7 +381,7 @@ E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
<font color=#3F5FBF>/**
* Retrieve context info for given context ID.
*
- * <font color=#7F9FBF>@param</font> id context ID.
+ * <font color=#7F9FBF>@param</font> id &ndash; context ID.
* <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed.
*/</font>
IToken getContext(String id, DoneGetContext done);
@@ -392,33 +392,33 @@ E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
<font color=#7F0055>interface</font> DoneGetContext {
<font color=#3F5FBF>/**
* Called when contexts data retrieval is done.
- * <font color=#7F9FBF>@param</font> error error description if operation failed, null if succeeded.
- * <font color=#7F9FBF>@param</font> context context data.
+ * <font color=#7F9FBF>@param</font> error &ndash; error description if operation failed, null if succeeded.
+ * <font color=#7F9FBF>@param</font> context &ndash; context data.
*/</font>
<font color=#7F0055>void</font> doneGetContext(IToken token, Exception error, RunControlContext context);
}
- <font color=#3F5FBF>/**
+ <font color=#3F5FBF>/**
* Retrieve children of given context.
*
- * <font color=#7F9FBF>@param</font> parent_context_id parent context ID. Can be null
+ * <font color=#7F9FBF>@param</font> parent_context_id &ndash; parent context ID. Can be null &ndash;
* to retrieve top level of the hierarchy, or one of context IDs retrieved
* by previous getContext or getChildren commands.
* <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed.
- */</font>
+ */</font>
IToken getChildren(String parent_context_id, DoneGetChildren done);
- <font color=#3F5FBF>/**
- * Client callback interface for getContexts().
- */</font>
- <font color=#7F0055>interface</font> DoneGetChildren {
- <font color=#3F5FBF>/**
- * Called when contexts data retrieval is done.
- * <font color=#7F9FBF>@param</font> error error description if operation failed, null if succeeded.
- * <font color=#7F9FBF>@param</font> contexts array of available context IDs.
- */</font>
- <font color=#7F0055>void</font> doneGetChildren(IToken token, RunControlError error, Context[] contexts);
- }
+ <font color=#3F5FBF>/**
+ * Client callback interface for getContexts().
+ */</font>
+ <font color=#7F0055>interface</font> DoneGetChildren {
+ <font color=#3F5FBF>/**
+ * Called when contexts data retrieval is done.
+ * <font color=#7F9FBF>@param</font> error &ndash; error description if operation failed, null if succeeded.
+ * <font color=#7F9FBF>@param</font> contexts &ndash; array of available context IDs.
+ */</font>
+ <font color=#7F0055>void</font> doneGetChildren(IToken token, RunControlError error, Context[] contexts);
+ }
<font color=#3F5FBF>/**
* A context corresponds to an execution thread, process, address space, etc.
@@ -429,13 +429,13 @@ E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
* with same IDs, however, each service accesses its own subset of context's
* attributes and functionality, which is relevant to that service.
*/</font>
- <font color=#7F0055>interface</font> RunControlContext {
+ <font color=#7F0055>interface</font> RunControlContext {
<font color=#3F5FBF>/**
* Retrieve context ID.
* Same as getProperties().get("ID")
*/</font>
- String getID();
+ String getID();
<font color=#3F5FBF>/**
* Retrieve parent context ID.
@@ -448,7 +448,7 @@ E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
* Context properties are read only, clients should not try to modify them.
* <font color=#7F9FBF>@return</font> Map of context properties.
*/</font>
- Map&lt;String,Object&gt; getProperties();
+ Map&lt;String,Object&gt; getProperties();
<font color=#3F5FBF>/**
* Utility method to read context property PROP_IS_CONTAINER.
@@ -537,10 +537,10 @@ E RunControl containerResumed <i>&lt;array of context IDs&gt;</i>
* <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
*/</font>
IToken terminate(DoneCommand done);
- }
+ }
- <font color=#7F0055>class</font> RunControlError <font color=#7F0055>extends</font> Exception {
- }
+ <font color=#7F0055>class</font> RunControlError <font color=#7F0055>extends</font> Exception {
+ }
<font color=#7F0055>interface</font> DoneGetState {
<font color=#7F0055>void</font> doneGetState(IToken token, Exception error, <font color=#7F0055>boolean</font> suspended, String pc,

Back to the top