Google Git
Sign in
eclipse / gerrit / ptp / org.eclipse.ptp / 17f7f1f7e5bcfe7ddc1b86b5c10bab3a6dbde83f / . / core / org.eclipse.ptp.doc.isv / reference / api / org / eclipse / ptp / debug / core / pdi / request / IPDIEventRequest.html
blob: cdbbe0dcbe49e4f9a83308c08bbaa998420c616d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Tue Jan 21 20:13:53 EST 2020 -->
<title>IPDIEventRequest (PTP API Specification)</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="dc.created" content="2020-01-21">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IPDIEventRequest (PTP API Specification)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IPDIEventRequest.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ptp.debug.core.pdi.request</a></div>
<h2 title="Interface IPDIEventRequest" class="title">Interface IPDIEventRequest</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../IPDISet.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISet</a></code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="IPDIBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIBreakpointRequest</a></code>, <code><a href="IPDICommandRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDICommandRequest</a></code>, <code><a href="IPDIConditionBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIConditionBreakpointRequest</a></code>, <code><a href="IPDIConnectionRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIConnectionRequest</a></code>, <code><a href="IPDIDataReadMemoryRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIDataReadMemoryRequest</a></code>, <code><a href="IPDIDataWriteMemoryRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIDataWriteMemoryRequest</a></code>, <code><a href="IPDIDeleteBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIDeleteBreakpointRequest</a></code>, <code><a href="IPDIDeleteVariableRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIDeleteVariableRequest</a></code>, <code><a href="IPDIDisableBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIDisableBreakpointRequest</a></code>, <code><a href="IPDIEnableBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIEnableBreakpointRequest</a></code>, <code><a href="IPDIEvaluateExpressionRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIEvaluateExpressionRequest</a></code>, <code><a href="IPDIEvaluatePartialExpressionRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIEvaluatePartialExpressionRequest</a></code>, <code><a href="IPDIGetInfoThreadsRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIGetInfoThreadsRequest</a></code>, <code><a href="IPDIGetStackInfoDepthRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIGetStackInfoDepthRequest</a></code>, <code><a href="IPDIGetVariableTypeRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIGetVariableTypeRequest</a></code>, <code><a href="IPDIGoRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIGoRequest</a></code>, <code><a href="IPDIHaltRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIHaltRequest</a></code>, <code><a href="IPDIInternalEventRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIInternalEventRequest</a></code>, <code><a href="IPDIListArgumentsRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIListArgumentsRequest</a></code>, <code><a href="IPDIListGlobalVariablesRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIListGlobalVariablesRequest</a></code>, <code><a href="IPDIListLocalVariablesRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIListLocalVariablesRequest</a></code>, <code><a href="IPDIListSignalsRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIListSignalsRequest</a></code>, <code><a href="IPDIListStackFramesRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIListStackFramesRequest</a></code>, <code><a href="IPDIRestartRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIRestartRequest</a></code>, <code><a href="IPDISetAddressBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetAddressBreakpointRequest</a></code>, <code><a href="IPDISetCurrentStackFrameRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetCurrentStackFrameRequest</a></code>, <code><a href="IPDISetFunctionBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetFunctionBreakpointRequest</a></code>, <code><a href="IPDISetLineBreakpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetLineBreakpointRequest</a></code>, <code><a href="IPDISetThreadSelectRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetThreadSelectRequest</a></code>, <code><a href="IPDISetWatchpointRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDISetWatchpointRequest</a></code>, <code><a href="IPDIStartDebuggerRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStartDebuggerRequest</a></code>, <code><a href="IPDIStepFinishRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepFinishRequest</a></code>, <code><a href="IPDIStepIntoInstructionRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepIntoInstructionRequest</a></code>, <code><a href="IPDIStepIntoRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepIntoRequest</a></code>, <code><a href="IPDIStepOverInstructionRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepOverInstructionRequest</a></code>, <code><a href="IPDIStepOverRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepOverRequest</a></code>, <code><a href="IPDIStepRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStepRequest</a></code>, <code><a href="IPDIStopDebuggerRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDIStopDebuggerRequest</a></code>, <code><a href="IPDITerminateRequest.html" title="interface in org.eclipse.ptp.debug.core.pdi.request">IPDITerminateRequest</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IPDIEventRequest</span>
extends <a href="../IPDISet.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISet</a></pre>
<div class="block">Represents a request for notification of an event.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACTION_NONE">ACTION_NONE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACTION_TERMINATED">ACTION_TERMINATED</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CANCELLED">CANCELLED</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DONE">DONE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ERROR">ERROR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RUNNING">RUNNING</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNKNOWN">UNKNOWN</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
<td class="colLast">
<div class="block">Cancels this request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#completed(org.eclipse.ptp.debug.core.TaskSet,java.lang.Object)">completed</a></span>&#8203;(<a href="../../TaskSet.html" title="class in org.eclipse.ptp.debug.core">TaskSet</a>&nbsp;qTasks,
java.lang.Object&nbsp;result)</code></th>
<td class="colLast">
<div class="block">Returns whether tasks are completed and set result</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#done()">done</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicates this request is complete.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#error(java.lang.String)">error</a></span>&#8203;(java.lang.String&nbsp;message)</code></th>
<td class="colLast">
<div class="block">Indicates this request has an error.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.eclipse.ptp.debug.core.pdi.IPDIDebugger)">execute</a></span>&#8203;(<a href="../IPDIDebugger.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDIDebugger</a>&nbsp;debugger)</code></th>
<td class="colLast">
<div class="block">Indicates this request is executing.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorMessage()">getErrorMessage</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns error message of this request</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns name of this request</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseAction()">getResponseAction</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns action type for action after completing this request</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatus()">getStatus</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current status of this request</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatus(int)">setStatus</a></span>&#8203;(int&nbsp;status)</code></th>
<td class="colLast">
<div class="block">Sets current status of this request</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.ptp.debug.core.pdi.IPDISet">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.ptp.debug.core.pdi.<a href="../IPDISet.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISet</a></h3>
<code><a href="../IPDISet.html#getTasks()">getTasks</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR</h4>
<pre>static final&nbsp;int ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="RUNNING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RUNNING</h4>
<pre>static final&nbsp;int RUNNING</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.RUNNING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DONE</h4>
<pre>static final&nbsp;int DONE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.DONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="CANCELLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANCELLED</h4>
<pre>static final&nbsp;int CANCELLED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.CANCELLED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNKNOWN</h4>
<pre>static final&nbsp;int UNKNOWN</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ACTION_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ACTION_NONE</h4>
<pre>static final&nbsp;int ACTION_NONE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.ACTION_NONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ACTION_TERMINATED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ACTION_TERMINATED</h4>
<pre>static final&nbsp;int ACTION_TERMINATED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest.ACTION_TERMINATED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setStatus(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatus</h4>
<pre class="methodSignature">void&nbsp;setStatus&#8203;(int&nbsp;status)</pre>
<div class="block">Sets current status of this request</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - </dd>
</dl>
</li>
</ul>
<a id="getStatus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre class="methodSignature">int&nbsp;getStatus()</pre>
<div class="block">Returns the current status of this request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current status of this request</dd>
</dl>
</li>
</ul>
<a id="done()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>done</h4>
<pre class="methodSignature">void&nbsp;done()</pre>
<div class="block">Indicates this request is complete. Clients must call this method whether
the request succeeds, fails, or is cancelled to indicate that processing
is complete. Only clients fulfilling a request should call this method.
Clients making a request are not intended to call this method.</div>
</li>
</ul>
<a id="cancel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">void&nbsp;cancel()</pre>
<div class="block">Cancels this request. A request may be cancelled by the originator of
request or a client fulfilling a request. Optionally a cancelled status
may be set on this request with more details. A client fulfilling a
request must still call <code>done()</code> to indicate the request is
complete.</div>
</li>
</ul>
<a id="execute(org.eclipse.ptp.debug.core.pdi.IPDIDebugger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">void&nbsp;execute&#8203;(<a href="../IPDIDebugger.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDIDebugger</a>&nbsp;debugger)</pre>
<div class="block">Indicates this request is executing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>debugger</code> - </dd>
</dl>
</li>
</ul>
<a id="error(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre class="methodSignature">void&nbsp;error&#8203;(java.lang.String&nbsp;message)</pre>
<div class="block">Indicates this request has an error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - error message</dd>
</dl>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">java.lang.String&nbsp;getName()</pre>
<div class="block">Returns name of this request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name of this request</dd>
</dl>
</li>
</ul>
<a id="getErrorMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre class="methodSignature">java.lang.String&nbsp;getErrorMessage()</pre>
<div class="block">Returns error message of this request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>error message of this request</dd>
</dl>
</li>
</ul>
<a id="completed(org.eclipse.ptp.debug.core.TaskSet,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completed</h4>
<pre class="methodSignature">boolean&nbsp;completed&#8203;(<a href="../../TaskSet.html" title="class in org.eclipse.ptp.debug.core">TaskSet</a>&nbsp;qTasks,
java.lang.Object&nbsp;result)</pre>
<div class="block">Returns whether tasks are completed and set result</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qTasks</code> - </dd>
<dd><code>result</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the tasks are completed</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="getResponseAction()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResponseAction</h4>
<pre class="methodSignature">int&nbsp;getResponseAction()</pre>
<div class="block">Returns action type for action after completing this request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>action type</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IPDIEventRequest.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p>
</footer>
</body>
</html>