Eclipse CDT
7.0

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

All Superinterfaces:
ICDIExecuteResume, ICDIExecuteStep, ICDIObject, ICDISuspend

public interface ICDIThread
extends ICDIExecuteStep, 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 lowFrame, int highFrame)
          Returns the stack frames contained in this thread whose levels are between the two arguments(inclusive).
 ICDIThreadStorageDescriptor[] getThreadStorageDescriptors()
          Return thread local storage variables descriptor.
 void jump(ICDILocation location)
          Deprecated.  
 void resume()
          Deprecated.  
 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.ICDIExecuteResume
resume, resume, resume
 
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

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

ICDIStackFrame[] getStackFrames(int lowFrame,
                                int highFrame)
                                throws CDIException
Returns the stack frames contained in this thread whose levels are between the two arguments(inclusive). 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:

getStackFrameCount

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

ICDIThreadStorageDescriptor[] getThreadStorageDescriptors()
                                                          throws CDIException
Return thread local storage variables descriptor.

Returns:
Throws:
CDIException

createThreadStorage

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

@Deprecated
void resume()
            throws CDIException
Deprecated. 

Equivalent to resume(false)

Throws:
CDIException - if this method fails. Reasons include:

stepOver

@Deprecated
void stepOver()
              throws CDIException
Deprecated. 

Equivalent to stepOver(1)

Throws:
CDIException - if this method fails. Reasons include:

stepInto

@Deprecated
void stepInto()
              throws CDIException
Deprecated. 

Equivalent to stepInto(1)

Throws:
CDIException - if this method fails. Reasons include:

stepOverInstruction

@Deprecated
void stepOverInstruction()
                         throws CDIException
Deprecated. 

Equivalent to stepOverInstruction(1)

Throws:
CDIException - if this method fails. Reasons include:

stepIntoInstruction

@Deprecated
void stepIntoInstruction()
                         throws CDIException
Deprecated. 

Equivalent to stepIntoInstruction(1)

Throws:
CDIException - if this method fails. Reasons include:

stepReturn

@Deprecated
void stepReturn()
                throws CDIException
Deprecated. 

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

Throws:
CDIException
See Also:
ICDIStackFrame.stepReturn()

runUntil

@Deprecated
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

@Deprecated
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

@Deprecated
void signal()
            throws CDIException
Deprecated. 

Equivalent to resume(false)

Throws:
CDIException
See Also:
ICDIExecuteResume.resume(boolean)

signal

@Deprecated
void signal(ICDISignal signal)
            throws CDIException
Deprecated. 

Equivalent to resume(signal)

Parameters:
signal -
Throws:
CDIException
See Also:
ICDIExecuteResume.resume(ICDISignal)

equals

boolean equals(ICDIThread thead)
Returns true if the threads are the same.


Eclipse CDT
7.0

Copyright (c) IBM Corp. and others 2004, 2012. All Rights Reserved.