Skip to main content
diff options
Diffstat (limited to 'docs/TCF Service - Run Control.html')
-rw-r--r--docs/TCF Service - Run Control.html48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/TCF Service - Run Control.html b/docs/TCF Service - Run Control.html
index 0b434bc06..36c65642f 100644
--- a/docs/TCF Service - Run Control.html
+++ b/docs/TCF Service - Run Control.html
@@ -18,6 +18,7 @@
<li><a href='#CmdSuspend'>Suspend</a>
<li><a href='#CmdResume'>Resume</a>
<li><a href='#CmdGetState'>Get State</a>
+ <li><a href='#CmdGetMinState'>Get Min State</a>
<li><a href='#CmdTerminate'>Terminate</a>
<li><a href='#CmdDetach'>Detach</a>
@@ -441,6 +442,29 @@ Definition of state properties depends on a target. Predefined properties are:</
human readable string to be used to decorate context presentation in UI
+<h3><a name='CmdGetMinState'>Get Min State</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; RunControl &bull; getMinState &bull; <i>&lt;string: context ID&gt;</i> &bull;
+<p>This command is meant as a "minimal" alternative to the more costly
+<a href='#CmdGetState'>Get State</a> command. Get Min State can be faster, because it does not need to read program counter from the target.
+It can be used as an optimization by clients (e.g. Eclipse GUI) that
+need only minimal information about the run control state of a context,
+i.e. running/suspended and a reason for the latter</p>
+<p>Result message:</p>
+<pre><b><font face="Courier New" size=2 color=#333399>
+R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;boolean: suspended&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>
+ &rArr; null
+ &rArr; <i>&lt;object: context state properties&gt;</i>
<h3><a name='CmdTerminate'>Terminate</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
@@ -1069,6 +1093,16 @@ E &bull; RunControl &bull; contextStateChanged &bull; <i>&lt;string: context IDs
IToken getState(DoneGetState done);
<font color=#3F5FBF>/**
+ * Send a command to retrieve current state of a context.
+ * Similar to getState, but does not retrieve PC.
+ * With some targets, it can be substantially faster.
+ * <font color=#7F9FBF>@param</font> done - command result call back object.
+ * <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
+ * <font color=#7F9FBF>@since</font> 1.7
+ */</font>
+ IToken getMinState(DoneGetMinState done);
+ <font color=#3F5FBF>/**
* Send a command to suspend a context.
* Also suspends children if context is a container.
* <font color=#7F9FBF>@param</font> done - command result call back object.
@@ -1126,6 +1160,20 @@ E &bull; RunControl &bull; contextStateChanged &bull; <i>&lt;string: context IDs
String reason, Map&lt;String,Object&gt; params);
+ <font color=#3F5FBF>/** <font color=#7F9FBF>@since</font> 1.7 */</font>
+ <font color=#7F0055>interface</font> DoneGetMinState {
+ <font color=#3F5FBF>/**
+ * Called when getMinState command execution is complete.
+ * <font color=#7F9FBF>@param</font> token - pending command handle.
+ * <font color=#7F9FBF>@param</font> error - command execution error or null.
+ * <font color=#7F9FBF>@param</font> suspended - true if the context is suspended
+ * <font color=#7F9FBF>@param</font> reason - suspend reason (if suspended), see REASON_*.
+ * <font color=#7F9FBF>@param</font> params - additional target specific data about context state, see STATE_*.
+ */</font>
+ <font color=#7F0055>void</font> doneGetMinState(IToken token, Exception error, <font color=#7F0055>boolean</font> suspended,
+ String reason, Map&lt;String,Object&gt; params);
+ }
<font color=#7F0055>interface</font> DoneCommand {
<font color=#3F5FBF>/**
* Called when run control command execution is complete.

Back to the top