org.eclipse.ptp.debug.core.pdi.request
Interface IPDIEventRequest

All Superinterfaces:

IPDISet

All Known Subinterfaces:

IPDIBreakpointRequest, IPDICommandRequest, IPDIConditionBreakpointRequest, IPDIConnectionRequest, IPDIDataReadMemoryRequest, IPDIDataWriteMemoryRequest, IPDIDeleteBreakpointRequest, IPDIDeleteVariableRequest, IPDIDisableBreakpointRequest, IPDIEnableBreakpointRequest, IPDIEvaluateExpressionRequest, IPDIEvaluatePartialExpressionRequest, IPDIGetInfoThreadsRequest, IPDIGetStackInfoDepthRequest, IPDIGetVariableTypeRequest, IPDIGoRequest, IPDIHaltRequest, IPDIInternalEventRequest, IPDIListArgumentsRequest, IPDIListGlobalVariablesRequest, IPDIListLocalVariablesRequest, IPDIListSignalsRequest, IPDIListStackFramesRequest, IPDIRestartRequest, IPDISetAddressBreakpointRequest, IPDISetCurrentStackFrameRequest, IPDISetFunctionBreakpointRequest, IPDISetLineBreakpointRequest, IPDISetThreadSelectRequest, IPDISetWatchpointRequest, IPDIStartDebuggerRequest, IPDIStepFinishRequest, IPDIStepIntoInstructionRequest, IPDIStepIntoRequest, IPDIStepOverInstructionRequest, IPDIStepOverRequest, IPDIStepRequest, IPDIStopDebuggerRequest, IPDITerminateRequest

public interface IPDIEventRequest
extends IPDISet

Represents a request for notification of an event.

Field Summary

static int	ACTION_NONE
static int	ACTION_TERMINATED
static int	CANCELLED
static int	DONE
static int	ERROR
static int	RUNNING
static int	UNKNOWN

Method Summary

void	cancel() Cancels this request.
boolean	completed(TaskSet qTasks, Object result) Returns whether tasks are completed and set result
void	done() Indicates this request is complete.
void	error(String message) Indicates this request has an error.
void	execute(IPDIDebugger debugger) Indicates this request is executing.
String	getErrorMessage() Returns error message of this request
String	getName() Returns name of this request
int	getResponseAction() Returns action type for action after completing this request
int	getStatus() Returns the current status of this request
void	setStatus(int status) Sets current status of this request

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISet

getTasks

Field Detail

ERROR

static final int ERROR

See Also:

Constant Field Values

RUNNING

static final int RUNNING

See Also:

Constant Field Values

DONE

static final int DONE

See Also:

Constant Field Values

CANCELLED

static final int CANCELLED

See Also:

Constant Field Values

UNKNOWN

static final int UNKNOWN

See Also:

Constant Field Values

ACTION_NONE

static final int ACTION_NONE

See Also:

Constant Field Values

ACTION_TERMINATED

static final int ACTION_TERMINATED

See Also:

Constant Field Values

Method Detail

setStatus

void setStatus(int status)

Sets current status of this request

Parameters:

status -

getStatus

int getStatus()

Returns the current status of this request

Returns:

the current status of this request

done

void done()

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.

cancel

void cancel()

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 done() to indicate the request is complete.

execute

void execute(IPDIDebugger debugger)

Indicates this request is executing.

Parameters:

debugger -

error

void error(String message)

Indicates this request has an error.

Parameters:

message - error message

getName

String getName()

Returns name of this request

Returns:

name of this request

getErrorMessage

String getErrorMessage()

Returns error message of this request

Returns:

error message of this request

completed

boolean completed(TaskSet qTasks,
                  Object result)

Returns whether tasks are completed and set result

Parameters:

qTasks -

result -

Returns:

true if the tasks are completed

Since:

4.0

getResponseAction

int getResponseAction()

Returns action type for action after completing this request

Returns:

action type