org.eclipse.ptp.debug.core.pdi.model

Interface IPDIThread

All Superinterfaces:

IPDISessionObject, IPDISet

public interface IPDIThread
extends IPDISessionObject

A thread in a debug target. A thread contains stack frames. Stack frames are only available when the thread is suspended, and are returned in top-down order.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STACKFRAME_DEFAULT_DEPTH

Method Summary

Modifier and Type	Method and Description
IPDIThreadStorage	createThreadStorage(IPDIThreadStorageDescriptor varDesc) Create a variable from the descriptor for evaluation.
boolean	equals(IPDIThread thead) Determines whether both threads are the same.
IPDIStackFrame	getCurrentStackFrame() Get current stack frame
int	getId() Get thread ID
int	getStackFrameCount() Returns the depth of the stack frames.
IPDIStackFrame[]	getStackFrames() Returns the stack frames contained in this thread.
IPDIStackFrame[]	getStackFrames(int fromIndex, int len) Returns the stack frames contained in this thread between the specified fromIndex, inclusive, and toIndex, exclusive.
IPDITarget	getTarget() Returns pdi target in this thread
IPDIThreadStorageDescriptor[]	getThreadStorageDescriptors() Return thread local storage variables descriptor.
void	setCurrentStackFrame(IPDIStackFrame stackframe)
void	setCurrentStackFrame(IPDIStackFrame stackframe, boolean doUpdate)

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

getSession

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

getTasks

Field Detail

STACKFRAME_DEFAULT_DEPTH

static final int STACKFRAME_DEFAULT_DEPTH

See Also:

Constant Field Values

Method Detail

createThreadStorage

IPDIThreadStorage createThreadStorage(IPDIThreadStorageDescriptor varDesc)
                               throws PDIException

Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and ChangedEvent will also be trigger when the variable is assign a new value. DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.

Parameters:

varDesc - IPDThreadStorageDesc

Returns:

IPDIThreadStorage

Throws:

PDIException - on failure

equals

boolean equals(IPDIThread thead)

Determines whether both threads are the same.

Parameters:

thead -

Returns:

true if the threads are the same.

getCurrentStackFrame

IPDIStackFrame getCurrentStackFrame()
                             throws PDIException

Get current stack frame

Returns:

Throws:

PDIException

getId

int getId()

Get thread ID

Returns:

getStackFrameCount

int getStackFrameCount()
                throws PDIException

Returns the depth of the stack frames.

Returns:

depth of stack frames

Throws:

PDIException - on failure

getStackFrames

IPDIStackFrame[] getStackFrames()
                         throws PDIException

Returns the stack frames contained in this thread. An empty collection is returned if this thread contains no stack frames, or is not currently suspended. Stack frames are returned in top down order.

Returns:

a collection of stack frames

Throws:

PDIException - on failure

getStackFrames

IPDIStackFrame[] getStackFrames(int fromIndex,
                                int len)
                         throws PDIException

Returns the stack frames contained in this thread between the specified fromIndex, inclusive, and toIndex, exclusive. An empty collection is returned if this thread contains no stack frames, or is not currently suspended. Stack frames are returned in top down order.

Returns:

a collection of stack frames

Throws:

PDIException - on failure

java.lang.IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).

getTarget

IPDITarget getTarget()

Returns pdi target in this thread

Returns:

pdi target in this thread

getThreadStorageDescriptors

IPDIThreadStorageDescriptor[] getThreadStorageDescriptors()
                                                   throws PDIException

Return thread local storage variables descriptor.

Returns:

IPDIThreadStorageDescriptor

Throws:

PDIException - on failure

setCurrentStackFrame

void setCurrentStackFrame(IPDIStackFrame stackframe)
                   throws PDIException

Parameters:

stackframe -

Throws:

PDIException

setCurrentStackFrame

void setCurrentStackFrame(IPDIStackFrame stackframe,
                          boolean doUpdate)
                   throws PDIException

Parameters:

stackframe -

doUpdate -

Throws:

PDIException