diff options
| author | fburton | 2008-05-10 01:35:19 +0000 |
|---|---|---|
| committer | fburton | 2008-05-10 01:35:19 +0000 |
| commit | e5d17e159a17f6958055e0481c461fd662a7b71c (patch) | |
| tree | 13c998255235b5d4348534421912b8b1f5061395 /docs/TCF Service - Registers.html | |
| parent | 3e13131ea2c6e6a4a21ca4cef9e2f1720146c435 (diff) | |
| download | org.eclipse.tcf-e5d17e159a17f6958055e0481c461fd662a7b71c.tar.gz org.eclipse.tcf-e5d17e159a17f6958055e0481c461fd662a7b71c.tar.xz org.eclipse.tcf-e5d17e159a17f6958055e0481c461fd662a7b71c.zip | |
Replaced non-ASCII characters with named HTML character entities
Diffstat (limited to 'docs/TCF Service - Registers.html')
| -rw-r--r-- | docs/TCF Service - Registers.html | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/docs/TCF Service - Registers.html b/docs/TCF Service - Registers.html index 44b713bdf..b47f490c7 100644 --- a/docs/TCF Service - Registers.html +++ b/docs/TCF Service - Registers.html @@ -43,7 +43,7 @@ multiple locations. This allows: <h3><a name='CmdGetContext'>Get Context</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • Registers • getContext • <i><string: context ID></i> • +C • <i><token></i> • Registers • getContext • <i><string: context ID></i> • </font></b></pre> <p>The command retrieves context info for given context ID. A context corresponds to an @@ -59,11 +59,11 @@ Target agent should define contexts hierarchy that is:</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><context data></i> • +R • <i><token></i> • <i><error report></i> • <i><context data></i> • <i><context data></i> - <font face=Wingdings>Ø</font> null - <font face=Wingdings>Ø</font> <i><object></i> + ⇒ null + ⇒ <i><object></i> </font></b></pre> <p>Context data object should, at least, contain member @@ -135,7 +135,7 @@ Service sends 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><token></i> • Registers • getChildren • <i><string: parent context ID></i> • +C • <i><token></i> • Registers • getChildren • <i><string: parent context ID></i> • </font></b></pre> <p>The command requests a list of contexts available for registers access commands.</p> @@ -148,23 +148,23 @@ It is up to target agent developers to choose layout that is most descriptive fo <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><array of context IDs></i> •<i></i> +R • <i><token></i> • <i><error report></i> • <i><array of context IDs></i> •<i></i> <i><array of context IDs></i> - <font face=Wingdings>Ø</font> null - <font face=Wingdings>Ø</font> [ ] - <font face=Wingdings>Ø</font> [ <i><context ID list></i> ] + ⇒ null + ⇒ [ ] + ⇒ [ <i><context ID list></i> ] <i><context ID list></i> - <font face=Wingdings>Ø</font> <i><string: context ID></i> - <font face=Wingdings>Ø</font> <i><context ID list></i> , <i><string: context ID></i> + ⇒ <i><string: context ID></i> + ⇒ <i><context ID list></i> , <i><string: context ID></i> </font></b></pre> <h3><a name='CmdSetRegister'>Set Register</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <token> • Registers • set • <i><string: context ID></i> • <i><string: value></i> • +C • <token> • Registers • set • <i><string: context ID></i> • <i><string: value></i> • </font></b></pre> <p>Writes value into given register context. Context ID must be one returned by getContexts. @@ -173,7 +173,7 @@ Value is BASE64 encoded byte array of binary data. Array size should match the s <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -182,7 +182,7 @@ of error.</p> <h3><a name='CmdGetRegister'>Get Register</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <token> • Registers • get • <i><string: context ID></i> • +C • <token> • Registers • get • <i><string: context ID></i> • </font></b></pre> <p>Reads register value from given register context. Context ID must be one returned by getContexts. @@ -191,7 +191,7 @@ C • <token> • Registers • get • <i><string: context ID></i> • <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><string: value></i> • +R • <i><token></i> • <i><error report></i> • <i><string: value></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -200,17 +200,17 @@ of error. Value is BASE64 encoded byte array of binary data. Array size should m <h3><a name='CmdSetMultiple'>Set Multiple Registers</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <token> • Registers • setm • <i><array of locations></i> • <i><string: value></i> • +C • <token> • Registers • setm • <i><array of locations></i> • <i><string: value></i> • <i><array of locations></i> - <font face=Wingdings>Ø</font> [ <i><location list></i> ] + ⇒ [ <i><location list></i> ] <i><location list></i> - <font face=Wingdings>Ø</font> <i><location></i> - <font face=Wingdings>Ø</font> <i><location list></i> , <i><location></i> + ⇒ <i><location></i> + ⇒ <i><location list></i> , <i><location></i> <i><location></i> - <font face=Wingdings>Ø</font> [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ] + ⇒ [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ] </font></b></pre> <p>Writes value into given list of locations in registers. Each location is represented by 3-element array that consists of @@ -220,7 +220,7 @@ Value is BASE64 encoded byte array of binary data. Byte array size should match <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -229,17 +229,17 @@ of error.</p> <h3><a name='CmdGetMultiple'>Get Multiple Registers</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <token> • Registers • getm • <i><array of locations></i> • +C • <token> • Registers • getm • <i><array of locations></i> • <i><array of locations></i> - <font face=Wingdings>Ø</font> [ <i><location list></i> ] + ⇒ [ <i><location list></i> ] <i><location list></i> - <font face=Wingdings>Ø</font> <i><location></i> - <font face=Wingdings>Ø</font> <i><location list></i> , <i><location></i> + ⇒ <i><location></i> + ⇒ <i><location list></i> , <i><location></i> <i><location></i> - <font face=Wingdings>Ø</font> [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ] + ⇒ [ <i><string: register context ID></i> , <i><int: offset in bytes></i> , <i><int: size in bytes></i> ] </font></b></pre> <p>Reads register values from given list of locations in registers. Each location is represented by 3-element array that consists of @@ -249,7 +249,7 @@ context ID, offset in the context in bytes and value size in bytes. <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><string: value></i> • +R • <i><token></i> • <i><error report></i> • <i><string: value></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -261,8 +261,8 @@ of error. Value is BASE64 encoded byte array of binary data. Byte array size sho a register content is altered by "set" commands.</p> <pre><b><font face="Courier New" size=2 color=#333399> -E • Registers • contextChanged • -E • Registers • registerChanged • <i><string: context ID></i> • +E • Registers • contextChanged • +E • Registers • registerChanged • <i><string: context ID></i> • </font></b></pre> <h2><a name='API'>API</a></h2> @@ -301,7 +301,7 @@ E • Registers • registerChanged • <i><string: context ID></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 – context ID. * <font color=#7F9FBF>@param</font> done - call back interface called when operation is completed. */</font> IToken getContext(String id, DoneGetContext done); @@ -312,8 +312,8 @@ E • Registers • registerChanged • <i><string: context ID></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 – error description if operation failed, null if succeeded. + * <font color=#7F9FBF>@param</font> context – context data. */</font> <font color=#7F0055>void</font> doneGetContext(IToken token, Exception error, RegistersContext context); } @@ -328,7 +328,7 @@ E • Registers • registerChanged • <i><string: context ID></i> • * with same IDs, however, each service accesses its own subset of context's * attributes and functionality, which is relevant to that service. * - * <font color=#7F9FBF>@param</font> parent_context_id – parent context ID. Can be null – + * <font color=#7F9FBF>@param</font> parent_context_id – parent context ID. Can be null – * to retrieve top level of the hierarchy, or one of context IDs retrieved * by previous getChildren commands. * <font color=#7F9FBF>@param</font> done - call back interface called when operation is completed. @@ -341,8 +341,8 @@ E • Registers • registerChanged • <i><string: context ID></i> • <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> context_ids – array of available context IDs. + * <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded. + * <font color=#7F9FBF>@param</font> context_ids – array of available context IDs. */</font> <font color=#7F0055>void</font> doneGetChildren(IToken token, Exception error, String[] context_ids); } |