Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Tarassov2019-03-22 17:33:41 -0400
committerEugene Tarassov2019-03-22 17:33:41 -0400
commit00ecf5d4f107dbe4071cf68e46be8f5730b0ac0b (patch)
tree16443e3eb2fb77eec23660cacc5c29a21e67b48d
parent7063b20c41be996918d751d777a7b0463c380965 (diff)
downloadorg.eclipse.tcf-00ecf5d4f107dbe4071cf68e46be8f5730b0ac0b.tar.gz
org.eclipse.tcf-00ecf5d4f107dbe4071cf68e46be8f5730b0ac0b.tar.xz
org.eclipse.tcf-00ecf5d4f107dbe4071cf68e46be8f5730b0ac0b.zip
TCF Docs: improved specifications of TCF services
-rw-r--r--docs/TCF Service - Breakpoints.html164
-rw-r--r--docs/TCF Service - Context Reset.html2
-rw-r--r--docs/TCF Service - Debug Print.html46
-rw-r--r--docs/TCF Service - Diagnostics.html531
-rw-r--r--docs/TCF Service - Disassembly.html33
-rw-r--r--docs/TCF Service - Expressions.html46
-rw-r--r--docs/TCF Service - Line Numbers.html46
-rw-r--r--docs/TCF Service - Profiler.html46
-rw-r--r--docs/TCF Service - Streams.html16
-rw-r--r--docs/TCF Service - Symbols.html46
-rw-r--r--docs/TCF Services.html24
-rw-r--r--plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java20
12 files changed, 873 insertions, 147 deletions
diff --git a/docs/TCF Service - Breakpoints.html b/docs/TCF Service - Breakpoints.html
index cced01ef9..e4830980b 100644
--- a/docs/TCF Service - Breakpoints.html
+++ b/docs/TCF Service - Breakpoints.html
@@ -58,12 +58,12 @@ A breakpoint identifier (String id) needs to be unique across all hosts and targ
<p>A breakpoint's property set is an extensible collection of named attributes,
which define the breakpoint's location, the conditions that trigger the breakpoint, and the actions
-executed as a result. As such, breakpoint properties are separated into three broad categories:
-<ul><b>
- <li>Location properties
- <li>Condition properties
- <li>Action properties
-</b></ul>
+executed as a result. As such, breakpoint properties are separated into three broad categories:</p>
+<ul>
+ <li><b>Location properties</b>
+ <li><b>Condition properties</b>
+ <li><b>Action properties</b>
+</ul>
<p>The Location and Condition properties dictate how a breakpoint is installed and whether it should be triggered.
The Action properties dictate the effect of the breakpoint if it is triggered.
@@ -151,132 +151,100 @@ Tools and targets can define additional properties. All provided properties need
A breakpoint service implementation may not change the properties set by the client.</p>
<p>Predefined properties are:</p>
-<dl>
<ul>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propID'>"ID"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>Breakpoint ID. This is the only required property.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propID'>"ID"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - Breakpoint ID. This is the only required property.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propeEnabled'>"Enabled"</a> : <i>&lt;boolean&gt;</i></font></b></code>
- <dd>If true, the breakpoint is enabled.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propeEnabled'>"Enabled"</a> : <i>&lt;boolean&gt;</i></font></b></code>
+ - If true, the breakpoint is enabled.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propBreakpointType'>"BreakpointType"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>The breakpoint type
- <dl>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propBreakpointType'>"BreakpointType"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - The breakpoint type
<ul>
- <li><dt><code><b>"Software"</b></code> <dd> Software breakpoint.</li>
- <li><dt><code><b>"Hardware"</b></code> <dd> Hardware breakpoint.</li>
- <li><dt><code><b>"Auto"</b></code> <dd> Installed breakpoint type (software/hardware) deferred to agent's discretion. This is the default breakpoint type.
+ <li><code><b>"Software"</b></code> - Software breakpoint.</li>
+ <li><code><b>"Hardware"</b></code> - Hardware breakpoint.</li>
+ <li><code><b>"Auto"</b></code> - Installed breakpoint type (software/hardware) deferred to agent's discretion. This is the default breakpoint type.
The actual type of each breakpoint instance consequently installed is received as a status event.</li>
</ul>
- </dl>
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propContextIDs'>"ContextIds"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>This property contains an array of TCF context identifiers for which this breakpoint should be installed.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propContextIDs'>"ContextIds"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - This property contains an array of TCF context identifiers for which this breakpoint should be installed.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propContextNames'>"ContextNames"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>This property contains an array of contexts names (such as a process/thread name) for which this breakpoint should be installed.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propContextNames'>"ContextNames"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - This property contains an array of contexts names (such as a process/thread name) for which this breakpoint should be installed.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propExecPaths'>"ExecPaths"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>This property contains all the target executable paths for which this breakpoint should be installed.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propExecPaths'>"ExecPaths"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - This property contains all the target executable paths for which this breakpoint should be installed.
- <li><dt><code><b><font face="Courier New" size="2" color=#333399><a name='propContextQuery'> "ContextQuery" </a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>This property contains a context query expression. The breakpoint is installed in a context if the expression is evaluted to "true" for that context.
- </li>
+ <li><code><b><font face="Courier New" size="2" color=#333399><a name='propContextQuery'> "ContextQuery" </a> : <i>&lt;string&gt;</i></font></b></code>
+ - This property contains a context query expression. The breakpoint is installed in a context if the expression is evaluted to "true" for that context.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propLocation'> "Location" </a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>If preset, defines location of the breakpoint. The expression evaluates either to a memory address
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propLocation'> "Location" </a> : <i>&lt;string&gt;</i></font></b></code>
+ - If preset, defines location of the breakpoint. The expression evaluates either to a memory address
or a register location.
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propAccessMode'>"AccessMode"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>The access mode that will trigger the breakpoint. Access mode can be a bitwise OR of the values below:
- <dl>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propAccessMode'>"AccessMode"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - The access mode that will trigger the breakpoint. Access mode can be a bitwise OR of the values below:
<ul>
- <li><dt><code><b>READ = 0x01</b></code> <dd>Triggered by a read from the breakpoint location.</li>
- <li><dt><code><b>WRITE = 0x02</b></code> <dd>Triggered by a write to the breakpoint location.</li>
- <li><dt><code><b>EXECUTE = 0x04</b></code> <dd>Triggered by an instruction execution at the breakpoint location. Whether the breakpoint is
+ <li><code><b>READ = 0x01</b></code> - Triggered by a read from the breakpoint location.</li>
+ <li><code><b>WRITE = 0x02</b></code> - Triggered by a write to the breakpoint location.</li>
+ <li><code><b>EXECUTE = 0x04</b></code> - Triggered by an instruction execution at the breakpoint location. Whether the breakpoint is
triggered before or after the instruction execution depends on the target support for this mode. This is the default for Line and Address breakpoints.</li>
- <li><dt><code><b>CHANGE = 0x08</b></code> <dd>Triggered by a data change (not an explicit write) at the breakpoint location.</li>
+ <li><code><b>CHANGE = 0x08</b></code> - Triggered by a data change (not an explicit write) at the breakpoint location.</li>
</ul>
- </dl>
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propSize'>"Size"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>The number of bytes starting at address given by the location expression.
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propSize'>"Size"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - The number of bytes starting at address given by the location expression.
AccessMode applies to accesses within the range [location .. location+size-1].
The MaskValue and Mask applies to the bytes within the range, i.e. the breakpoint triggers when (valueof[location .. location+size-1] & Mask) == (MaskValue & Mask).
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propFile'>"File"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>Source code file name of breakpoint location.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propFile'>"File"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - Source code file name of breakpoint location.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propLine'>"Line"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>Source code line number of breakpoint location.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propLine'>"Line"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - Source code line number of breakpoint location.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propColumn'>"Column"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>Source code column number of breakpoint location.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propColumn'>"Column"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - Source code column number of breakpoint location.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propMaskValue'>"MaskValue"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>A breakpoint can be qualified with a mask value which may be further refined with a mask.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propMaskValue'>"MaskValue"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - A breakpoint can be qualified with a mask value which may be further refined with a mask.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propMask'>"Mask"</a> : <i>&lt;int&gt;</i></font></b></code>
- <dd>A mask which is bitwise ANDed with the value accessed.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propMask'>"Mask"</a> : <i>&lt;int&gt;</i></font></b></code>
+ - A mask which is bitwise ANDed with the value accessed.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propTime'>"Time"</a> : <i>&lt;number&gt;</i></font></b></code>
- <dd>The time value in the execution of the program at which to set the breakpoint
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propTime'>"Time"</a> : <i>&lt;number&gt;</i></font></b></code>
+ - The time value in the execution of the program at which to set the breakpoint
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propTimeScale'>"TimeScale"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>The scale for the time value
- <dl>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propTimeScale'>"TimeScale"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - The scale for the time value
<ul>
- <li><dt><code><b>"Relative"</b></code> <dd> Time value in the relative time scale. This is the default value for this property.
+ <li><code><b>"Relative"</b></code> - Time value in the relative time scale. This is the default value for this property.
In the relative time scale, the Time property may have a negative value.</li>
- <li><dt><code><b>"Absolute"</b></code> <dd> Time value in the absolute time scale.</li>
- </ul>
- </dl>
- </li>
-
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propTimeUnits'>"TimeUnits"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>The units for the time value
- <dl>
+ <li><code><b>"Absolute"</b></code> - Time value in the absolute time scale.</li>
+ </ul>
+
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propTimeUnits'>"TimeUnits"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - The units for the time value
<ul>
- <li><dt><code><b>"CycleCount"</b></code> <dd> Time value in cycles. This is the default type.</li>
- <li><dt><code><b>"NanoSeconds"</b></code> <dd> Time value in nano seconds.</li>
- <li><dt><code><b>"InstructionCount"</b></code> <dd> Time value in instructions.</li>
+ <li><code><b>"CycleCount"</b></code> - Time value in cycles. This is the default type.</li>
+ <li><code><b>"NanoSeconds"</b></code> - Time value in nano seconds.</li>
+ <li><code><b>"InstructionCount"</b></code> - Time value in instructions.</li>
</ul>
- </dl>
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propCondition'>"Condition"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>Expression that must evaluate to true before the breakpoint is triggered.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propCondition'>"Condition"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - Expression that must evaluate to true before the breakpoint is triggered.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propIgnoreCount'>"IgnoreCount"</a>: <i>&lt;int&gt;</i></font></b></code>
- <dd>The number of times this breakpoint is to be ignored before it is triggered. The ignore count is tested after all other Location and Condition properties are validated.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propIgnoreCount'>"IgnoreCount"</a>: <i>&lt;int&gt;</i></font></b></code>
+ - The number of times this breakpoint is to be ignored before it is triggered. The ignore count is tested after all other Location and Condition properties are validated.
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name = 'propStopGroup'>"StopGroup"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>An array of TCF Context identifiers representing contexts to be stopped when this breakpoint is triggered.
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name = 'propStopGroup'>"StopGroup"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - An array of TCF Context identifiers representing contexts to be stopped when this breakpoint is triggered.
This is an "Action" property that is used to stop contexts in addition to the one that triggered the breakpoint.
- </li>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propTemporary'>"Temporary"</a> : <i>&lt;boolean&gt;</i></font></b></code>
- <dd>If set, results in the breakpoint being removed after it is triggered once. The default value for this property is false.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propTemporary'>"Temporary"</a> : <i>&lt;boolean&gt;</i></font></b></code>
+ - If set, results in the breakpoint being removed after it is triggered once. The default value for this property is false.
</ul>
-</dl>
<p>Reply:</p>
@@ -352,8 +320,8 @@ C &bull; <i>&lt;token&gt;</i> &bull; Breakpoints &bull; change &bull; <i>&lt;bre
<p>The command updates the breakpoint data in the target agent breakpoint table. The host should send this command when the user modifies a breakpoint.</p>
<ul>
-<li><dt><code><b><font face="Courier New" size=2 color=#333399><i>&lt;breakpoint data&gt;</i></font></b></code>
-<dd>Must be the full set of the breakpoint properties: those that are changed AND those that are not. Any previous property that is not sent in the change command will be removed from the breakpoint.
+<li><code><b><font face="Courier New" size=2 color=#333399><i>&lt;breakpoint data&gt;</i></font></b></code>
+- Must be the full set of the breakpoint properties: those that are changed AND those that are not. Any previous property that is not sent in the change command will be removed from the breakpoint.
</li>
</ul>
diff --git a/docs/TCF Service - Context Reset.html b/docs/TCF Service - Context Reset.html
index 255d0b1ba..1fc7c3ca5 100644
--- a/docs/TCF Service - Context Reset.html
+++ b/docs/TCF Service - Context Reset.html
@@ -90,7 +90,7 @@ R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>
<h2><a name='API'>API</a></h2>
<pre>
-public <font color=#7F0055>interface</font> IContextReset <font color=#7F0055>extends</font> IService {
+<font color=#7F0055>public interface</font> IContextReset <font color=#7F0055>extends</font> IService {
<font color=#3F5FBF>/**
* Service name.
diff --git a/docs/TCF Service - Debug Print.html b/docs/TCF Service - Debug Print.html
new file mode 100644
index 000000000..544e959d0
--- /dev/null
+++ b/docs/TCF Service - Debug Print.html
@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Debug Print</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Debug Print</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Debug Print Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Diagnostics.html b/docs/TCF Service - Diagnostics.html
new file mode 100644
index 000000000..eebcfeffe
--- /dev/null
+++ b/docs/TCF Service - Diagnostics.html
@@ -0,0 +1,531 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Diagnostics</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Diagnostics</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <ul>
+ <li><a href='#CmdEcho'>Echo</a>
+ <li><a href='#CmdEchoFP'>Echo FP</a>
+ <li><a href='#CmdEchoINT'>Echo INT</a>
+ <li><a href='#CmdEchoERR'>Echo ERR</a>
+ <li><a href='#CmdGetTestList'>Get Test List</a>
+ <li><a href='#CmdRunTest'>Run Test</a>
+ <li><a href='#CmdCancelTest'>Cancel Test</a>
+ <li><a href='#CmdGetSymbol'>Get Symbol</a>
+ <li><a href='#CmdCreateTestStreams'>Create Test Streams</a>
+ <li><a href='#CmdDisposeTestStream'>Dispose Test Stream</a>
+ </ul>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Diagnostics Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The Diagnostics service is used for testing of the peer and
+ communication channel functionality and reliability.</p>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+ <h3><a name='CmdEcho'>Echo</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; echo &bull; <i>&lt;string: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ The command is used to test communication channel ability to transmit arbitrary
+ strings in both directions.
+ </p>
+ <p>Reply:</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;string: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains same string as the command argument.
+ </p>
+
+ <h3><a name='CmdEchoFP'>Echo FP</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; echoFP &bull; <i>&lt;float: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ The command is used to test communication channel ability to transmit arbitrary
+ floating point numbers in both directions.
+ </p>
+ <p>Reply:</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;float: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains same number as the command argument.
+ </p>
+
+ <h3><a name='CmdEchoINT'>Echo INT</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; echoINT &bull; <i>&lt;integer: type&gt;</i> &bull; <i>&lt;integer: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ The command is used to test communication channel ability to transmit arbitrary
+ integer numbers in both directions. Type can be:
+ </p>
+ <ul>
+ <li><code><b><font face="Courier New" size=2 color=#333399>0</font></b></code>
+ - signed integer number, up to 32 bits
+ <li><code><b><font face="Courier New" size=2 color=#333399>1</font></b></code>
+ - unsigned integer number, up to 32 bits
+ <li><code><b><font face="Courier New" size=2 color=#333399>2</font></b></code>
+ - long signed number, up to 64 bits
+ <li><code><b><font face="Courier New" size=2 color=#333399>3</font></b></code>
+ - long unsigned, up to 64 bits
+ </ul>
+ <p>Reply:</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;integer: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains same number as the command argument.
+ </p>
+
+ <h3><a name='CmdEchoERR'>Echo ERR</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; echoERR &bull; <i>&lt;error report: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ The command is used to test remote agent ability to receive and transmit TCF error reports.
+ </p>
+ <p>Reply:</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;error report: test pattern&gt;</i> &bull; <i>&lt;string: test pattern&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains same error report as the command argument, and the same report converted to a human readable string.
+ </p>
+
+ <h3><a name='CmdGetTestList'>Get Test List</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; getTestList &bull;
+</font></b></pre>
+ <p>
+ Get list of test names that are implemented by the service.
+ Clients can request remote peer to run a test from the list.
+ When started, a test performs a predefined set actions.
+ Nature of test actions is uniquely identified by test name.
+ Exact description of test actions is a contract between client and remote peer,
+ and it is not part of Diagnostics service specifications.
+ Clients should not attempt to run a test if they don't recognize the test name.
+ </p>
+ <p>Reply:</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;string array: test names&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains names of tests that are supported by the peer.
+ </p>
+
+ <h3><a name='CmdRunTest'>Run Test</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; runTest &bull; <i>&lt;string: test name&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Run a test. When started, a test performs a predefined set actions.
+ Nature of test actions is uniquely identified by test name.
+ Running test usually has associated execution context ID.
+ Depending on the test, the ID can be used with services RunControl and/or Processes services to control
+ test execution, and to obtain test results.
+ </p>
+ <p>Reply:</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;string: test context ID&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains test execution contest ID.
+ </p>
+
+ <h3><a name='CmdCancelTest'>Cancel Test</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; cancelTest &bull; <i>&lt;string: test context ID&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Cancel execution of a test.
+ </p>
+ <p>Reply:</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;
+</font></b></pre>
+
+ <h3><a name='CmdGetSymbol'>Get Symbol</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; getSymbol &bull; <i>&lt;string: symbol name&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Get information about a symbol in a test execution context.
+ </p>
+ <p>Reply:</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;object: symbol properties&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains properties of the symbol.
+ </p>
+ <p>Predefined properties are:</p>
+ <ul>
+ <li><code><b><font face="Courier New" size=2 color=#333399>"Section" : <i>&lt;string&gt;</i></font></b></code>
+ - The name of the section that own the symbol.
+ <li><code><b><font face="Courier New" size=2 color=#333399>"Value" : <i>&lt;integer&gt;</i></font></b></code>
+ - The value of the symbol.
+ <li><code><b><font face="Courier New" size=2 color=#333399>"Abs" : <i>&lt;boolean&gt;</i></font></b></code>
+ - True if the symbol reprsent an absolute address.
+ <li><code><b><font face="Courier New" size=2 color=#333399>"Storage" : <i>&lt;string&gt;</i></font></b></code>
+ - The type of storage of the symbol. Possible values are:
+ <ul>
+ <li><code><b><font face="Courier New" size=2 color=#333399>COMMON</font></b></code>
+ <li><code><b><font face="Courier New" size=2 color=#333399>GLOBAL</font></b></code>
+ <li><code><b><font face="Courier New" size=2 color=#333399>LOCAL</font></b></code>
+ <li><code><b><font face="Courier New" size=2 color=#333399>UNDEF</font></b></code>
+ </ul>
+ </ul>
+
+ <h3><a name='CmdCreateTestStreams'>Create Test Streams</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; createTestStreams &bull; <i>&lt;integer: input buffer size&gt;</i> &bull; <i>&lt;integer: output buffer size&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Create a pair of virtual streams, see <a href='TCF Service - Streams.html'>Streams</a> service.
+ Remote ends of the streams are connected together, so any data sent into 'inp' stream
+ will become available for reading from 'out' stream.
+ The command is used for testing virtual streams.
+ </p>
+ <p>Reply:</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;string: input ID&gt;</i> &bull; <i>&lt;string: output ID&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains IDs of created streams pair.
+ </p>
+
+ <h3><a name='CmdDisposeTestStream'>Dispose Test Stream</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; Diagnostics &bull; disposeTestStream &bull; <i>&lt;string: stream ID&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Dispose a virtual stream that was created by 'createTestStreams' command.
+ </p>
+ <p>Reply:</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;
+</font></b></pre>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+<font color=#3F5FBF>/**
+ * This is optional service that can be implemented by a peer.
+ * If implemented, the service can be used for testing of the peer and
+ * communication channel functionality and reliability.
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ */</font>
+
+<font color=#7F0055>public interface</font> IDiagnostics <font color=#7F0055>extends</font> IService {
+
+ <font color=#7F0055>static final</font> String NAME = "Diagnostics";
+
+ <font color=#3F5FBF>/**
+ * 'echo' command result returns same string that was given as command argument.
+ * The command is used to test communication channel ability to transmit arbitrary strings in
+ * both directions.
+ * @param s - any string.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken echo(String s, DoneEcho done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'echo' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneEcho {
+ <font color=#3F5FBF>/**
+ * Called when 'echo' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param s - same string as the command argument.
+ */</font>
+ <font color=#7F0055>void</font> doneEcho(IToken token, Throwable error, String s);
+ }
+
+ <font color=#3F5FBF>/**
+ * 'echoFP' command result returns same floating point number that was given as command argument.
+ * The command is used to test communication channel ability to transmit arbitrary floating point numbers in
+ * both directions.
+ * @param n - any floating point number.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken echoFP(BigDecimal n, DoneEchoFP done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'echoFP' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneEchoFP {
+ <font color=#3F5FBF>/**
+ * Called when 'echoFP' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param n - same number as the command argument.
+ */</font>
+ <font color=#7F0055>void</font> doneEchoFP(IToken token, Throwable error, BigDecimal n);
+ }
+
+ <font color=#3F5FBF>/**
+ * 'echoINT' command result returns same integer number that was given as command argument.
+ * The command is used to test communication channel ability to transmit arbitrary integer numbers in
+ * both directions.
+ * @param t - number type:
+ * 0 - signed, up to 32 bits
+ * 1 - unsigned, up to 32 bits
+ * 2 - signed, up to 64 bits
+ * 3 - unsigned, up to 64 bits
+ * @param n - the number.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ * @since 1.4
+ */</font>
+ IToken echoINT(<font color=#7F0055>int</font> t, BigInteger n, DoneEchoINT done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'echoINT' command.
+ * @since 1.4
+ */</font>
+ <font color=#7F0055>interface</font> DoneEchoINT {
+ <font color=#3F5FBF>/**
+ * Called when 'echoINT' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param n - same number as the command argument.
+ */</font>
+ <font color=#7F0055>void</font> doneEchoINT(IToken token, Throwable error, BigInteger n);
+ }
+
+ <font color=#3F5FBF>/**
+ * 'echoERR' command result returns same error report that was given as command argument.
+ * The command is used to test remote agent ability to receive and transmit TCF error reports.
+ * @param error - an error object.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken echoERR(Throwable error, DoneEchoERR done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'echoERR' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneEchoERR {
+ <font color=#3F5FBF>/**
+ * Called when 'echoERR' command is done.
+ * @param token - command handle.
+ * @param error - communication error report or null.
+ * @param error_obj - error object, should be equal to the command argument.
+ * @param error_msg - error object converted to a human readable string.
+ */</font>
+ <font color=#7F0055>void</font> doneEchoERR(IToken token, Throwable error, Throwable error_obj, String error_msg);
+ }
+
+ <font color=#3F5FBF>/**
+ * Get list of test names that are implemented by the service.
+ * Clients can request remote peer to run a test from the list.
+ * When started, a test performs a predefined set actions.
+ * Nature of test actions is uniquely identified by test name.
+ * Exact description of test actions is a contract between client and remote peer,
+ * and it is not part of Diagnostics service specifications.
+ * Clients should not attempt to run a test if they don't recognize the test name.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken getTestList(DoneGetTestList done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'getTestList' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneGetTestList {
+ <font color=#3F5FBF>/**
+ * Called when 'getTestList' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param list - names of tests that are supported by the peer.
+ */</font>
+ <font color=#7F0055>void</font> doneGetTestList(IToken token, Throwable error, String[] list);
+ }
+
+ <font color=#3F5FBF>/**
+ * Run a test. When started, a test performs a predefined set actions.
+ * Nature of test actions is uniquely identified by test name.
+ * Running test usually has associated execution context ID.
+ * Depending on the test, the ID can be used with services RunControl and/or Processes services to control
+ * test execution, and to obtain test results.
+ * @param name - test name
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken runTest(String name, DoneRunTest done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'runTest' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneRunTest {
+ <font color=#3F5FBF>/**
+ * Called when 'runTest' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param context_id - test execution contest ID.
+ */</font>
+ <font color=#7F0055>void</font> doneRunTest(IToken token, Throwable error, String context_id);
+ }
+
+ <font color=#3F5FBF>/**
+ * Cancel execution of a test.
+ * @param context_id - test execution context ID.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken cancelTest(String context_id, DoneCancelTest done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'cancelTest' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneCancelTest {
+ <font color=#3F5FBF>/**
+ * Called when 'cancelTest' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ */</font>
+ <font color=#7F0055>void</font> doneCancelTest(IToken token, Throwable error);
+ }
+
+ <font color=#3F5FBF>/**
+ * Get information about a symbol in test execution context.
+ * @param context_id - test execution context ID, returned by the runTest command.
+ * @param symbol_name - name of the symbol
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken getSymbol(String context_id, String symbol_name, DoneGetSymbol done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'getSymbol' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneGetSymbol {
+ <font color=#3F5FBF>/**
+ * Called when 'getSymbol' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param symbol - symbol properties
+ */</font>
+ <font color=#7F0055>void</font> doneGetSymbol(IToken token, Throwable error, ISymbol symbol);
+ }
+
+ <font color=#3F5FBF>/**
+ * Interface to access result value of 'getSymbol' command.
+ */</font>
+ <font color=#7F0055>interface</font> ISymbol {
+ String getSectionName();
+ Number getValue();
+ <font color=#7F0055>boolean</font> isUndef();
+ <font color=#7F0055>boolean</font> isCommon();
+ <font color=#7F0055>boolean</font> isGlobal();
+ <font color=#7F0055>boolean</font> isLocal();
+ <font color=#7F0055>boolean</font> isAbs();
+ }
+
+ <font color=#3F5FBF>/**
+ * Create a pair of virtual streams, @see IStreams service.
+ * Remote ends of the streams are connected together, so any data sent into 'inp' stream
+ * will become available for reading from 'out' stream.
+ * The command is used for testing virtual streams.
+ * @param inp_buf_size - buffer size in bytes of the input stream.
+ * @param out_buf_size - buffer size in bytes of the output stream.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken createTestStreams(<font color=#7F0055>int</font> inp_buf_size, <font color=#7F0055>int</font> out_buf_size, DoneCreateTestStreams done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'createTestStreams' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneCreateTestStreams {
+
+ <font color=#3F5FBF>/**
+ * Called when 'createTestStreams' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ * @param inp_id - the input stream ID.
+ * @param out_id - the output stream ID.
+ */</font>
+ <font color=#7F0055>void</font> doneCreateTestStreams(IToken token, Throwable error, String inp_id, String out_id);
+ }
+
+ <font color=#3F5FBF>/**
+ * Dispose a virtual stream that was created by 'createTestStreams' command.
+ * @param id - the stream ID.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken disposeTestStream(String id, DoneDisposeTestStream done);
+
+ <font color=#3F5FBF>/**
+ * Call back interface for 'disposeTestStream' command.
+ */</font>
+ <font color=#7F0055>interface</font> DoneDisposeTestStream {
+
+ <font color=#3F5FBF>/**
+ * Called when 'createTestStreams' command is done.
+ * @param token - command handle.
+ * @param error - error object or null.
+ */</font>
+ <font color=#7F0055>void</font> doneDisposeTestStream(IToken token, Throwable error);
+ }
+
+ <font color=#3F5FBF>/**
+ * Send a command that is not implemented by peer.
+ * Used to test handling of 'N' messages by communication channel.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken not_implemented_command(DoneNotImplementedCommand done);
+
+ <font color=#7F0055>interface</font> DoneNotImplementedCommand {
+
+ <font color=#3F5FBF>/**
+ * Called when 'not_implemented_command' command is done.
+ * @param token - command handle.
+ * @param error - error object.
+ */</font>
+ <font color=#7F0055>void</font> doneNotImplementedCommand(IToken token, Throwable error);
+ }
+}
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Disassembly.html b/docs/TCF Service - Disassembly.html
index c8d2c661e..9ab51a0c1 100644
--- a/docs/TCF Service - Disassembly.html
+++ b/docs/TCF Service - Disassembly.html
@@ -55,25 +55,16 @@ C &bull; <i>&lt;token&gt;</i> &bull; Disassembly &bull; disassemble &bull; <i>&l
<p>Where context-id is the memory context in which to process the command.</p>
<p>Predefined properties are:</p>
-<dl>
<ul>
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propISA'>"ISA"</a> : <i>&lt;string&gt;</i></font></b></code>
- <dd>The name of the instruction set architecture.
- </li>
-
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propSimplified'>"Simplified"</a> : <i>&lt;boolean&gt;</i></font></b></code>
- <dd>If true, simplified mnemonics are specified.
- </li>
-
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propPseudoInst'>"PseudoInstructions"</a> : <i>&lt;boolean&gt;</i></font></b></code>
- <dd>If true, pseudo-instructions are requested.
- </li>
-
- <li><dt><code><b><font face="Courier New" size=2 color=#333399><a name='propOpcodeValue'>"OpcodeValue"</a> : <i>&lt;boolean&gt;</i></font></b></code>
- <dd>If true, the instruction code byte values are returned.
- </li>
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propISA'>"ISA"</a> : <i>&lt;string&gt;</i></font></b></code>
+ - The name of the instruction set architecture.
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propSimplified'>"Simplified"</a> : <i>&lt;boolean&gt;</i></font></b></code>
+ - If true, simplified mnemonics are specified.
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propPseudoInst'>"PseudoInstructions"</a> : <i>&lt;boolean&gt;</i></font></b></code>
+ - If true, pseudo-instructions are requested.
+ <li><code><b><font face="Courier New" size=2 color=#333399><a name='propOpcodeValue'>"OpcodeValue"</a> : <i>&lt;boolean&gt;</i></font></b></code>
+ - If true, the instruction code byte values are returned.
</ul>
-</dl>
<p>Reply:</p>
@@ -100,13 +91,13 @@ R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;a
<li><code><b><font face="Courier New" size=2 color=#333399>"ISA" : <i>&lt;string&gt;</i></font></b></code>
- Instruction Set Architecture of the disassembly line
<li><code><b><font face="Courier New" size=2 color=#333399>"Address" : <i>&lt;int&gt;</i></font></b></code>
- - Address of the instruction
+ - Address of the instruction
<li><code><b><font face="Courier New" size=2 color=#333399>"Size" : <i>&lt;int&gt;</i></font></b></code>
- - Size of the instruction in bytes
+ - Size of the instruction in bytes
<li><code><b><font face="Courier New" size=2 color=#333399>"Instruction" : <i>&lt;array&gt;</i></font></b></code>
- - Array of the intruction fields
+ - Array of the intruction fields
<li><code><b><font face="Courier New" size=2 color=#333399>"OpcodeValue" : <i>&lt;string&gt;</i></font></b></code>
- - Encoded byte array of the instruction binary representation
+ - Encoded byte array of the instruction binary representation
</ul>
<pre><b><font face="Courier New" size=2 color=#333399>
diff --git a/docs/TCF Service - Expressions.html b/docs/TCF Service - Expressions.html
new file mode 100644
index 000000000..f8e919651
--- /dev/null
+++ b/docs/TCF Service - Expressions.html
@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Expressions</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Expressions</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Expressions Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Line Numbers.html b/docs/TCF Service - Line Numbers.html
new file mode 100644
index 000000000..3888cf5ca
--- /dev/null
+++ b/docs/TCF Service - Line Numbers.html
@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Line Numbers</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Line Numbers</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Line Numbers Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Profiler.html b/docs/TCF Service - Profiler.html
new file mode 100644
index 000000000..41db1c00a
--- /dev/null
+++ b/docs/TCF Service - Profiler.html
@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Profiler</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Profiler</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Profiler Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Streams.html b/docs/TCF Service - Streams.html
index b69a9db0f..76734e1fd 100644
--- a/docs/TCF Service - Streams.html
+++ b/docs/TCF Service - Streams.html
@@ -115,8 +115,8 @@ C &bull; <i>&lt;token&gt;</i> &bull; Streams &bull; read &bull; <i>&lt;string: s
</font></b></pre>
<ul>
- <li><dt><code><b>stream ID</b></code> <dd>ID of stream that will be read.
- <li><dt><code><b>size</b></code> <dd>Maximum number of bytes to read.
+ <li><code><b>stream ID</b></code> - ID of stream that will be read.
+ <li><code><b>size</b></code> - Maximum number of bytes to read.
</ul>
<p>The command reads data from a stream. If stream buffer is empty, the command will wait until data is available.
@@ -135,12 +135,12 @@ R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;string: data&gt;</i> &bull; <i>&lt;e
</font></b></pre>
<ul>
- <li><dt><code><b>data</b></code> <dd>Data bytes that were read from the stream. By default, data is BASE64 encoded.
+ <li><code><b>data</b></code> - Data bytes that were read from the stream. By default, data is BASE64 encoded.
Peers can send unencoded binary data if both implement ZeroCopy service.
- <li><dt><code><b>lost size</b></code> <dd>Number of bytes that were lost because of buffer overflow.
+ <li><code><b>lost size</b></code> - Number of bytes that were lost because of buffer overflow.
-1 means unknown number of bytes were lost. if both 'lost_size' and 'data.length' are non-zero then lost bytes are considered
located right before read bytes.
- <li><dt><code><b>EOS</b></code> <dd>true if end of stream was reached.
+ <li><code><b>EOS</b></code> - true if end of stream was reached.
</ul>
<h3><a name='CmdWrite'>Write</a></h3>
@@ -150,9 +150,9 @@ C &bull; <i>&lt;token&gt;</i> &bull; Streams &bull; write &bull; <i>&lt;string:
</font></b></pre>
<ul>
- <li><dt><code><b>stream ID</b></code> <dd>ID of stream that will receive the data.
- <li><dt><code><b>size</b></code> <dd>Number of bytes to write. Length of unencoded <code><b>data</b></code> must match the size.
- <li><dt><code><b>data</b></code> <dd>Data bytes that will be written to the stream. By default, data is BASE64 encoded.
+ <li><code><b>stream ID</b></code> - ID of stream that will receive the data.
+ <li><code><b>size</b></code> - Number of bytes to write. Length of unencoded <code><b>data</b></code> must match the size.
+ <li><code><b>data</b></code> - Data bytes that will be written to the stream. By default, data is BASE64 encoded.
Peers can send unencoded binary data if both implement ZeroCopy service.
</ul>
diff --git a/docs/TCF Service - Symbols.html b/docs/TCF Service - Symbols.html
new file mode 100644
index 000000000..a1d8a3aa1
--- /dev/null
+++ b/docs/TCF Service - Symbols.html
@@ -0,0 +1,46 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework Services - Symbols</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework Services - Symbols</h1>
+
+<ul>
+ <li><a href='#VersionHistory'>Version History</a>
+ <li><a href='#Overview'>Overview</a>
+ <li><a href='#Cmds'>Commands</a>
+ <li><a href='#API'>API</a>
+</ul>
+
+<h1>Symbols Service</h1>
+
+<h2><a name='VersionHistory'>Version History</a></h2>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Version
+ <th>Date
+ <th>Change
+ <tr>
+ <td>1.0
+ <td>2011-11-11
+ <td>Initial
+</table>
+
+<h2><a name='Overview'>Overview</a></h2>
+
+<p>The service uses standard format for error reports,
+see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
+
+<h2><a name='Cmds'>Commands</a></h2>
+
+<h2><a name='API'>API</a></h2>
+
+<pre>
+</pre>
+
+</body>
+</html>
diff --git a/docs/TCF Services.html b/docs/TCF Services.html
index 926efc1a9..b491ee255 100644
--- a/docs/TCF Services.html
+++ b/docs/TCF Services.html
@@ -200,22 +200,28 @@ same way as "OTHER".</p>
<h2><a name='Services'>Services</h2>
<ul>
+ <li><a href='TCF Service - Breakpoints.html'>Breakpoints Service</a></li>
+ <li><a href='TCF Service - Context Query.html'>Context Query Service</a></li>
+ <li><a href='TCF Service - Context Reset.html'>Context Reset Service</a></li>
+ <li><a href='TCF Service - Diagnostics.html'>Diagnostics Service</a></li>
+ <li><a href='TCF Service - Disassembly.html'>Disassembly Service</a></li>
+ <li><a href='TCF Service - Debug Print.html'>Debug Print Service</a></li>
+ <li><a href='TCF Service - Expressions.html'>Expressions Service</a></li>
+ <li><a href='TCF Service - File System.html'>File System Service</a></li>
+ <li><a href='TCF Service - Line Numbers.html'>Line Numbers Service</a></li>
<li><a href='TCF Specification.html#Locator'>Locator Service</a></li>
<li><a href='TCF Service - Memory.html'>Memory Service</a></li>
+ <li><a href='TCF Service - Memory Map.html'>Memory Map Service</a></li>
+ <li><a href='TCF Service - Path Map.html'>Path Map Service</a></li>
<li><a href='TCF Service - Processes.html'>Processes Service</a></li>
- <li><a href='TCF Service - Run Control.html'>Run Control Service</a></li>
+ <li><a href='TCF Service - Profiler.html'>Profiler Service</a></li>
<li><a href='TCF Service - Registers.html'>Registers Service</a></li>
+ <li><a href='TCF Service - Run Control.html'>Run Control Service</a></li>
<li><a href='TCF Service - Stack Trace.html'>Stack Trace Service</a></li>
- <li><a href='TCF Service - Breakpoints.html'>Breakpoints Service</a></li>
- <li><a href='TCF Service - Memory Map.html'>Memory Map Service</a></li>
- <li><a href='TCF Service - Path Map.html'>Path Map Service</a></li>
- <li><a href='TCF Service - File System.html'>File System Service</a></li>
+ <li><a href='TCF Service - Streams.html'>Streams Service</a></li>
+ <li><a href='TCF Service - Symbols.html'>Symbols Service</a></li>
<li><a href='TCF Service - System Monitor.html'>System Monitor Service</a></li>
<li><a href='TCF Service - Terminals.html'>Terminals Service</a></li>
- <li><a href='TCF Service - Streams.html'>Streams Service</a></li>
- <li><a href='TCF Service - Disassembly.html'>Disassembly Service</a></li>
- <li><a href='TCF Service - Context Query.html'>Context Query Service</a></li>
- <li><a href='TCF Service - Context Reset.html'>Context Reset Service</a></li>
</ul>
</body>
diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java
index f0352694f..63f845283 100644
--- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java
+++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2007, 2016 Wind River Systems, Inc. and others.
+ * Copyright (c) 2007-2019 Wind River Systems, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -180,7 +180,7 @@ public interface IDiagnostics extends IService {
/**
* Cancel execution of a test.
- * @param context_id - text execution context ID.
+ * @param context_id - test execution context ID.
* @param done - command result call back object.
* @return - pending command handle.
*/
@@ -199,11 +199,11 @@ public interface IDiagnostics extends IService {
}
/**
- * Get information about a symbol in text execution context.
- * @param context_id
- * @param symbol_name
- * @param done
- * @return
+ * Get information about a symbol in a test execution context.
+ * @param context_id - test execution context ID, returned by the runTest command.
+ * @param symbol_name - name of the symbol
+ * @param done - command result call back object.
+ * @return - pending command handle.
*/
IToken getSymbol(String context_id, String symbol_name, DoneGetSymbol done);
@@ -215,7 +215,7 @@ public interface IDiagnostics extends IService {
* Called when 'getSymbol' command is done.
* @param token - command handle.
* @param error - error object or null.
- * @param symbol
+ * @param symbol - symbol properties
*/
void doneGetSymbol(IToken token, Throwable error, ISymbol symbol);
}
@@ -235,8 +235,8 @@ public interface IDiagnostics extends IService {
/**
* Create a pair of virtual streams, @see IStreams service.
- * Remote ends of the streams are connected, so any data sent into 'inp' stream
- * will become for available for reading from 'out' stream.
+ * Remote ends of the streams are connected together, so any data sent into 'inp' stream
+ * will become available for reading from 'out' stream.
* The command is used for testing virtual streams.
* @param inp_buf_size - buffer size in bytes of the input stream.
* @param out_buf_size - buffer size in bytes of the output stream.

Back to the top