org.eclipse.cdt.debug.core.cdi.model
Interface ICDIThread

All Superinterfaces:

org.eclipse.cdt.debug.core.cdi.model.ICDIExecuteResume, ICDIExecuteStep, ICDIObject, ICDISuspend

public interface ICDIThread

extends ICDIExecuteStep, org.eclipse.cdt.debug.core.cdi.model.ICDIExecuteResume, ICDISuspend, ICDIObject

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.

Since:

Jul 8, 2002

Method Summary

ICDIThreadStorage	createThreadStorage(ICDIThreadStorageDescriptor varDesc) Create a variable from the descriptor for evaluation.
boolean	equals(ICDIThread thead) Returns true if the threads are the same.
int	getStackFrameCount() Returns the depth of the stack frames.
ICDIStackFrame[]	getStackFrames() Returns the stack frames contained in this thread.
ICDIStackFrame[]	getStackFrames(int fromIndex, int len) Returns the stack frames contained in this thread between the specified fromIndex, inclusive, and toIndex, exclusive.
ICDIThreadStorageDescriptor[]	getThreadStorageDescriptors() Return thread local storage variables descriptor.
void	jump(ICDILocation location) Deprecated.
void	resume() Deprecated.
void	resume(boolean passSignal) Causes this target to resume its execution.
void	resume(ICDILocation location) Resume execution at location.
void	resume(ICDISignal signal) Resume execution where the program stopped but immediately give the signal.
void	runUntil(ICDILocation location) Deprecated.
void	signal() Deprecated.
void	signal(ICDISignal signal) Deprecated.
void	stepInto() Deprecated.
void	stepIntoInstruction() Deprecated.
void	stepOver() Deprecated.
void	stepOverInstruction() Deprecated.
void	stepReturn() Deprecated.

Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIExecuteStep

stepInto, stepIntoInstruction, stepOver, stepOverInstruction, stepUntil

Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDISuspend

isSuspended, suspend

Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIObject

getTarget

Method Detail

getStackFrames

public ICDIStackFrame[] getStackFrames()
                                throws CDIException

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:

CDIException - if this method fails. Reasons include:

getStackFrames

public ICDIStackFrame[] getStackFrames(int fromIndex,
                                       int len)
                                throws CDIException

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:

CDIException - if this method fails. Reasons include:

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

getStackFrameCount

public int getStackFrameCount()
                       throws CDIException

Returns the depth of the stack frames.

Returns:

depth of stack frames

Throws:

CDIException - if this method fails. Reasons include:

getThreadStorageDescriptors

public ICDIThreadStorageDescriptor[] getThreadStorageDescriptors()
                                                          throws CDIException

Return thread local storage variables descriptor.

Returns:

Throws:

CDIException

createThreadStorage

public ICDIThreadStorage createThreadStorage(ICDIThreadStorageDescriptor varDesc)
                                      throws CDIException

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 - ICDThreadStorageDesc

Returns:

Throws:

CDIException

resume

public void resume()
            throws CDIException

Deprecated.

Equivalent to resume(false)

Throws:

CDIException - if this method fails. Reasons include:

stepOver

public void stepOver()
              throws CDIException

Deprecated.

Equivalent to stepOver(1)

Throws:

CDIException - if this method fails. Reasons include:

stepInto

public void stepInto()
              throws CDIException

Deprecated.

Equivalent to stepInto(1)

Throws:

CDIException - if this method fails. Reasons include:

stepOverInstruction

public void stepOverInstruction()
                         throws CDIException

Deprecated.

Equivalent to stepOverInstruction(1)

Throws:

CDIException - if this method fails. Reasons include:

stepIntoInstruction

public void stepIntoInstruction()
                         throws CDIException

Deprecated.

Equivalent to stepIntoInstruction(1)

Throws:

CDIException - if this method fails. Reasons include:

stepReturn

public void stepReturn()
                throws CDIException

Deprecated.

This method is deprecated and will only be available on the stackframe

Throws:

CDIException

See Also:

ICDIStackFrame.stepReturn()

runUntil

public void runUntil(ICDILocation location)
              throws CDIException

Deprecated.

Equivalent to stepUntil(location)

Throws:

CDIException - if this method fails. Reasons include:

See Also:

ICDIExecuteStep.stepUntil(ICDILocation)

jump

public void jump(ICDILocation location)
          throws CDIException

Deprecated.

Equivalent to resume(location)

Throws:

CDIException - if this method fails. Reasons include:

See Also:

ICDIExecuteResume.resume(ICDILocation)

signal

public void signal()
            throws CDIException

Deprecated.

Equivalent to resume(false)

Throws:

CDIException

See Also:

ICDIExecuteResume.resume(boolean)

signal

public void signal(ICDISignal signal)
            throws CDIException

Deprecated.

Equivalent to resume(signal)

Parameters:

signal -

Throws:

CDIException

See Also:

ICDIExecuteResume.resume(ICDISignal)

equals

public boolean equals(ICDIThread thead)

Returns true if the threads are the same.

resume

public void resume(boolean passSignal)
            throws CDIException

Causes this target to resume its execution. if passSignal is fase and the target was suspended by a signal when resuming the signal will be discarded Has no effect on a target that is not suspended.

Parameters:

passSignal - whether to discar the signal

Throws:

CDIException - if this method fails. Reasons include:

resume

public void resume(ICDILocation location)
            throws CDIException

Resume execution at location. Note the method does not change stackframe. The result is undefined if it jumps outside of the stacframe. Can only be called when the associated target is suspended.

Parameters:

location -

Throws:

CDIException - if this method fails. Reasons include:

resume

public void resume(ICDISignal signal)
            throws CDIException

Resume execution where the program stopped but immediately give the signal.

Parameters:

signal -

Throws:

CDIException