diff options
Diffstat (limited to 'docs/TCF Service - Processes.html')
| -rw-r--r-- | docs/TCF Service - Processes.html | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/docs/TCF Service - Processes.html b/docs/TCF Service - Processes.html index dbb3f0309..3b64c2843 100644 --- a/docs/TCF Service - Processes.html +++ b/docs/TCF Service - Processes.html @@ -42,7 +42,7 @@ see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p> <h3><a name='CmdGetContext'>Get Context</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes getContext <i><string: context ID></i> +C • <i><token></i> • Processes • getContext • <i><string: context ID></i> • </font></b></pre> <p>The command retrieves context info for given context ID. @@ -57,11 +57,11 @@ useful information. <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 @@ -89,12 +89,12 @@ R <i><token></i> <i><error report></i> <i><context data> <h3><a name='CmdGetChildren'>Get Children</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes getChildren <i><string: parent context ID></i> +C • <i><token></i> • Processes • getChildren • <i><string: parent context ID></i> • </font></b></pre> <p>The command requests a list of contexts available for process 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 – 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> @@ -102,22 +102,22 @@ 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><token></i> <i><error report></i> <i><array of context IDs></i> +R • <i><token></i> • <i><error report></i> • <i><array of context IDs></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='CmdAttach'>Attach</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes attach <i><string: context ID></i> +C • <i><token></i> • Processes • attach • <i><string: context ID></i> • </font></b></pre> <p>The command attaches debugger to a process. @@ -126,13 +126,13 @@ Services like Run Control, Memory, Breakpoints work only with attached processes <p>Reply:</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> <h3><a name='CmdDetach'>Detach</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes detach <i><string: context ID></i> +C • <i><token></i> • Processes • detach • <i><string: context ID></i> • </font></b></pre> <p>The command detaches debugger from a process.</p> @@ -140,13 +140,13 @@ C <i><token></i> Processes detach <i><string: context ID></i <p>Reply:</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> <h3><a name='CmdTerminate'>Terminate</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes terminate <i><string: context ID></i> +C • <i><token></i> • Processes • terminate • <i><string: context ID></i> • </font></b></pre> <p>The command terminates a process.</p> @@ -154,13 +154,13 @@ C <i><token></i> Processes terminate <i><string: context ID> <p>Reply:</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> <h3><a name='CmdSignal'>Signal</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes signal <i><string: context ID></i> <i><int: signal></i> +C • <i><token></i> • Processes • signal • <i><string: context ID></i> • <i><int: signal></i> • </font></b></pre> <p>The command sends a signal to a process.</p> @@ -168,23 +168,23 @@ C <i><token></i> Processes signal <i><string: context ID></i <p>Reply:</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> <h3><a name='CmdStart'>Start</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Processes start <i><string: working directory></i> <i><string: program image file></i> - <i><string array: command line></i> <i><string array: environment variables></i> <i><boolean: attach></i> +C • <i><token></i> • Processes • start • <i><string: working directory></i> • <i><string: program image file></i> • + <i><string array: command line></i> • <i><string array: environment variables></i> • <i><boolean: attach></i> • <i><string array></i> - <font face=Wingdings>Ψ</font> null - <font face=Wingdings>Ψ</font> [ ] - <font face=Wingdings>Ψ</font> [ <i><string list></i> ] + ⇒ null + ⇒ [ ] + ⇒ [ <i><string list></i> ] <i><string list></i> - <font face=Wingdings>Ψ</font> <i><string></i> - <font face=Wingdings>Ψ</font> <i><string list></i> , <i><string></i> + ⇒ <i><string></i> + ⇒ <i><string list></i> , <i><string></i> </font></b></pre> <p>The command starts a new process on remote machine. @@ -198,7 +198,7 @@ they will be added to default process environment. <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> • </font></b></pre> <p>On success the command returns context data for created process. Context data has same format as Get Context result.</p> @@ -224,7 +224,7 @@ R <i><token></i> <i><error report></i> <i><context data> * If the ID is not a process ID, 'IProcesses.getContext' may not return any * useful information * - * <font color=#7F9FBF><font color=#7F9FBF>@param</font></font> id context ID. + * <font color=#7F9FBF><font color=#7F9FBF>@param</font></font> id – context ID. * <font color=#7F9FBF><font color=#7F9FBF>@param</font></font> done - call back interface called when operation is completed. */</font> IToken getContext(String id, DoneGetContext done); @@ -235,8 +235,8 @@ R <i><token></i> <i><error report></i> <i><context data> <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, ProcessContext context); } @@ -244,7 +244,7 @@ R <i><token></i> <i><error report></i> <i><context data> <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 – parent context ID. Can be null – * 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 - call back interface called when operation is completed. @@ -257,8 +257,8 @@ R <i><token></i> <i><error report></i> <i><context data> <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); } @@ -286,20 +286,20 @@ R <i><token></i> <i><error report></i> <i><context data> <font color=#3F5FBF>/** * Get context ID. - * Same as getProperties().get(ID) + * Same as getProperties().get(“ID”) */</font> String getID(); <font color=#3F5FBF>/** * Get parent context ID. - * Same as getProperties().get(ParentID) + * Same as getProperties().get(“ParentID”) */</font> String getParentID(); <font color=#3F5FBF>/** * Get process name. * Client UI can show this name to a user. - * Same as getProperties().get(Name) + * Same as getProperties().get(“Name”) */</font> String getName(); |