Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Tarassov2019-03-25 15:19:35 -0400
committerEugene Tarassov2019-03-25 15:19:35 -0400
commit03acc28cfd9657347d8c42c13f981b181994dcab (patch)
treea3b4424c2bf23c554293137603d3ae82f87ac6ae
parentb339b7ad6692f104bfd64ee6a78c1cea345d11d5 (diff)
downloadorg.eclipse.tcf-03acc28cfd9657347d8c42c13f981b181994dcab.tar.gz
org.eclipse.tcf-03acc28cfd9657347d8c42c13f981b181994dcab.tar.xz
org.eclipse.tcf-03acc28cfd9657347d8c42c13f981b181994dcab.zip
TCF Docs: improved specifications of Debug Print service
-rw-r--r--docs/TCF Service - Debug Print.html84
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/TCF Service - Debug Print.html b/docs/TCF Service - Debug Print.html
index 544e959d0..0baf630b8 100644
--- a/docs/TCF Service - Debug Print.html
+++ b/docs/TCF Service - Debug Print.html
@@ -12,6 +12,10 @@
<li><a href='#VersionHistory'>Version History</a>
<li><a href='#Overview'>Overview</a>
<li><a href='#Cmds'>Commands</a>
+ <ul>
+ <li><a href='#CmdOpen'>Open</a>
+ <li><a href='#CmdClose'>Close</a>
+ </ul>
<li><a href='#API'>API</a>
</ul>
@@ -32,14 +36,94 @@
<h2><a name='Overview'>Overview</a></h2>
+<p>
+ The service provides access to "dynamic printf" output stream that is generated by invocations of
+ '$printf' function by the <a href='TCF Service - Expressions.html'>Expressions</a> service on the remote target.
+</p>
+<p>
+ The function has same arguments as the C library function int printf(const char * format, ...).
+ While '$printf' is most usefull as a breakpoint action, any debugger expression can call the function.
+</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='CmdOpen'>Open</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; DPrintf &bull; open &bull; <i>&lt;object: stream properties&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Open "dynamic printf" stream.
+ If the stream is already open, just return its ID.
+ </p>
+ <p>
+ Stream properties are optional and can be null. No standard stream properties are defined yet.
+ </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: stream ID&gt;</i> &bull;
+</font></b></pre>
+ <p>
+ Reply contains ID of the stream.
+ The stream is accessible through the <a href='TCF Service - Streams.html'>Streams</a> service.
+ </p>
+
+ <h3><a name='CmdClose'>Close</a></h3>
+<pre><b><font face="Courier New" size=2 color=#333399>
+C &bull; <i>&lt;token&gt;</i> &bull; DPrintf &bull; close &bull;
+</font></b></pre>
+ <p>
+ Close "dynamic printf" stream.
+ </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>/**
+ * DPrintf service provides access to "dynamic printf" output stream that is generated by invocations of
+ * '$printf' function on the remote target. '$printf' is usually used as a breakpoint action.
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ */</font>
+<font color=#7F0055>public interface</font> IDPrintf <font color=#7F0055>extends</font> IService {
+
+ <font color=#3F5FBF>/**
+ * Service name.
+ */</font>
+ <font color=#7F0055>static final</font> String NAME = "DPrintf";
+
+ <font color=#3F5FBF>/**
+ * Open "dynamic printf" stream and get ID of the stream.
+ * The service maintains one such stream per client.
+ * The stream is managed by Streams service.
+ * @param properties - optional stream properties.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken open(Map&lt;String,Object&gt;[] properties, DoneCommandOpen done);
+
+ <font color=#7F0055>interface</font> DoneCommandOpen {
+ <font color=#7F0055>void</font> doneCommandOpen(IToken token, Exception error, String id);
+ }
+
+ <font color=#3F5FBF>/**
+ * Close "dynamic printf" stream.
+ * Further '$printf' output will be discarded.
+ * @param done - command result call back object.
+ * @return - pending command handle.
+ */</font>
+ IToken close(DoneCommandClose done);
+
+ <font color=#7F0055>interface</font> DoneCommandClose {
+ <font color=#7F0055>void</font> doneCommandClose(IToken token, Exception error);
+ }
+}
</pre>
</body>

Back to the top