org.eclipse.ptp.debug.core.pdi
Interface IPDISession

All Superinterfaces:

IPDIExecuteManagement, IPDISessionObject, IPDISet

public interface IPDISession
extends IPDISessionObject, IPDIExecuteManagement

Represents a debug session

Field Summary

static int	CONNECTED
static int	CONNECTING
static int	DISCONNECTED
static int	EXITED
static int	EXITING
static int	STARTED

Method Summary

void	connectToDebugger(IProgressMonitor monitor, String app, String path, String dir, String[] args) Connect to the debugger
void	exit() Causes this session to exit
IPDITarget	findTarget(TaskSet task) Returns debug target on given task id or null if target is not registered
IPDIBreakpointManager	getBreakpointManager() Returns the breakpoint manager for this session
IPDIDebugger	getDebugger() Returns a debugger for this session
IPDIEventFactory	getEventFactory() Get the factory to create events for this session
IPDIEventManager	getEventManager() Returns the event manager for this session
IPDIEventRequestManager	getEventRequestManager() Returns the event request manager for this session
IPDIExpressionManager	getExpressionManager() Returns the expression manager for this session
String	getJobID() Returns job id associated with this session
IPDIMemoryManager	getMemoryManager() Returns the memory manager for this session
IPDIModelFactory	getModelFactory() Get the factory to create model elements for this session
IPDIRegisterManager	getRegisterManager() Returns the register manager for this session
IPDIRequestFactory	getRequestFactory() Returns request factory
IPDISignalManager	getSignalManager() Returns the signal manager for this session
IPDISourceManager	getSourceManager() Get the source manager
int	getStatus() Returns current status of this session
IPDITargetManager	getTargetManager() Returns the target manager for this session
IPDITaskManager	getTaskManager() Returns the task manager for this session
TaskSet	getTasks() Returns all tasks of this session
IPDIThreadManager	getThreadManager() Returns the thread manager for this session
long	getTimeout() Get the debugger timeout
int	getTotalTasks() Returns total tasks in this session
IPDIVariableManager	getVariableManager() Returns the variable manager for this session
boolean	isSuspended(TaskSet tasks) Returns whether this target/thread is currently suspended.
boolean	isTerminated(TaskSet tasks) Returns whether this target/thread is currently terminated.
void	processRunningEvent(TaskSet tasks) Process the running event for the given tasks
void	processSupsendedEvent(TaskSet tasks, int thread_id, String[] vars) Process the suspended event for the given tasks
void	queueRunnable(Runnable runnable)
void	setRequestTimeout(long timeout) Sets a timeout for request
void	setStatus(int status) Set status for session
void	shutdown(boolean force) Shutdown this session
void	validateStepReturn(TaskSet tasks) Checks whether request tasks can do step return

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

getSession

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

restart, resume, resume, resume, start, stepInto, stepIntoInstruction, stepOver, stepOverInstruction, stepReturn, stepReturn, stepUntil, suspend, terminate

Field Detail

DISCONNECTED

static final int DISCONNECTED

Since:

5.0

See Also:

Constant Field Values

CONNECTING

static final int CONNECTING

See Also:

Constant Field Values

CONNECTED

static final int CONNECTED

See Also:

Constant Field Values

STARTED

static final int STARTED

See Also:

Constant Field Values

EXITING

static final int EXITING

See Also:

Constant Field Values

EXITED

static final int EXITED

See Also:

Constant Field Values

Method Detail

processRunningEvent

void processRunningEvent(TaskSet tasks)

Process the running event for the given tasks

Parameters:

tasks -

Since:

4.0

getSourceManager

IPDISourceManager getSourceManager()

Get the source manager

Returns:

processSupsendedEvent

void processSupsendedEvent(TaskSet tasks,
                           int thread_id,
                           String[] vars)

Process the suspended event for the given tasks

Parameters:

tasks -

thread_id -

vars -

Since:

4.0

connectToDebugger

void connectToDebugger(IProgressMonitor monitor,
                       String app,
                       String path,
                       String dir,
                       String[] args)
                       throws PDIException

Connect to the debugger

Parameters:

monitor -

app -

path -

dir -

args -

Throws:

PDIException - on failure

exit

void exit()
          throws PDIException

Causes this session to exit

Throws:

PDIException - on failure

findTarget

IPDITarget findTarget(TaskSet task)
                      throws PDIException

Returns debug target on given task id or null if target is not registered

Parameters:

tid - task id

Returns:

debug target

Throws:

PDIException - on failure

Since:

4.0

getBreakpointManager

IPDIBreakpointManager getBreakpointManager()

Returns the breakpoint manager for this session

Returns:

IPDIBreakpointManager the breakpoint manager for this session

getDebugger

IPDIDebugger getDebugger()

Returns a debugger for this session

Returns:

a debugger for this session

getEventFactory

IPDIEventFactory getEventFactory()

Get the factory to create events for this session

Returns:

getEventManager

IPDIEventManager getEventManager()

Returns the event manager for this session

Returns:

IPDIEventManager the event request manager for this session

getEventRequestManager

IPDIEventRequestManager getEventRequestManager()

Returns the event request manager for this session

Returns:

IPDIEventRequestManager the event request manager for this session

getExpressionManager

IPDIExpressionManager getExpressionManager()

Returns the expression manager for this session

Returns:

IPDIExpressionManager the expression manager for this session

getJobID

String getJobID()

Returns job id associated with this session

Returns:

job id

getMemoryManager

IPDIMemoryManager getMemoryManager()

Returns the memory manager for this session

Returns:

IPDIMemoryManager the memory manager for this session

getModelFactory

IPDIModelFactory getModelFactory()

Get the factory to create model elements for this session

Returns:

getRegisterManager

IPDIRegisterManager getRegisterManager()

Returns the register manager for this session

Returns:

IPDIRegisterManager the register manager for this session

getRequestFactory

IPDIRequestFactory getRequestFactory()

Returns request factory

Returns:

request factory

getSignalManager

IPDISignalManager getSignalManager()

Returns the signal manager for this session

Returns:

IPDISignalManager the signal manager for this session

getStatus

int getStatus()

Returns current status of this session

Returns:

current status of this session

getTargetManager

IPDITargetManager getTargetManager()

Returns the target manager for this session

Returns:

IPDITargetManager the target manager for this session

getTaskManager

IPDITaskManager getTaskManager()

Returns the task manager for this session

Returns:

IPDITaskManager the task manager for this session

getTasks

TaskSet getTasks()

Returns all tasks of this session

Specified by:

getTasks in interface IPDISet

Returns:

all tasks of this session

getThreadManager

IPDIThreadManager getThreadManager()

Returns the thread manager for this session

Returns:

IPDIThreadManager the thread manager for this session

getTimeout

long getTimeout()

Get the debugger timeout

Returns:

getTotalTasks

int getTotalTasks()

Returns total tasks in this session

Returns:

total tasks in this session

getVariableManager

IPDIVariableManager getVariableManager()

Returns the variable manager for this session

Returns:

IPDIVariableManager the variable manager for this session

isSuspended

boolean isSuspended(TaskSet tasks)

Returns whether this target/thread is currently suspended.

Parameters:

tasks - target process

Returns:

whether this target/thread is currently suspended

Since:

4.0

isTerminated

boolean isTerminated(TaskSet tasks)

Returns whether this target/thread is currently terminated.

Parameters:

tasks - target process

Returns:

whether this target/thread is currently terminated

Since:

4.0

queueRunnable

void queueRunnable(Runnable runnable)

Parameters:

runnable -

setRequestTimeout

void setRequestTimeout(long timeout)

Sets a timeout for request

setStatus

void setStatus(int status)

Set status for session

Parameters:

status - status of current session

shutdown

void shutdown(boolean force)

Shutdown this session

Parameters:

force - whether force to terminate debugger

validateStepReturn

void validateStepReturn(TaskSet tasks)
                        throws PDIException

Checks whether request tasks can do step return

Parameters:

tasks -

Throws:

PDIException

Since:

4.0