Packages | Classes | Enumerations

# Package BinNavi.API.debug

Contains classes to access the debugger. More...

## Packages
package | raw

| Contains classes to handling raw debugger messages.
## Classes
class | Bookmark
| Represents a single memory bookmark. More...
class | BookmarkListenerAdapter
| Adapter class for bookmarks. More...
class | BookmarkManager
| Used to set and manage memory bookmarks. More...
class | BookmarkManagerListenerAdapter
| Adapter class for bookmark managers. More...
class | Breakpoint
| Represents a single breakpoint. More...
class | BreakpointHelpers
| Offers convenience functions for working with breakpoints. More...
class | BreakpointListenerAdapter
| Adapter class for breakpoints. More...
class | BreakpointManager
| Used to set and remove breakpoints. More...
class | BreakpointManagerListenerAdapter
| Adapter class for breakpoint managers. More...
class | DebugException
| Debugger exception class. More...
class | Debugger
| Used to debug a target process. More...
class | DebuggerListenerAdapter
| Adapter class for debugger events. More...
interface | IBookmarkListener
| Used to listen on memory bookmarks. More...
interface | IBookmarkManagerListener
| Used to listen on bookmark managers. More...
interface | IBreakpointListener
| Used to listen on breakpoints. More...
interface | IBreakpointManagerListener
| Used to listen on breakpoint managers. More...
interface | IDebuggerListener
| Interface for listening on raw debugger messages. More...
interface | IMemoryListener
| Used to listen on target process memory. More...
interface | IProcessListener
| Used to listen on a target process. More...
interface | IThreadListener
| Used to listen on threads of a target process. More...
class | Memory
| Simulates the memory of a target process. More...
class | MemoryListenerAdapter
| Adapter class for simulated memory. More...
class | MemoryMap
| Describes the layout of the target process memory. More...
class | MemoryModule
| Module inside a debugged target process. More...
class | MemorySection
| Single allocated section of the target memory. More...
class | MissingDataException
| Used to signal missing data. More...
class | Process
| Target process of the debugger. More...
class | ProcessListenerAdapter
| Adapter class for target processes. More...
class | Register
| Single register value of a thread. More...
class | TargetInformation
| Describes the target architecture. More...
class | Thread
| A single thread of a target process. More...
class | ThreadListenerAdapter
| Adapter class for threads. More...
class | TraceLogger
| Creates debug event trace logs. More...
## Enumerations
enum | BreakpointStatus { Active, Inactive, Disabled, Hit, Enabled, Invalid, Deleting }
| Enumeration of valid breakpoint states. More...
enum | ThreadState { Running, Suspended }
| Describes the state of target process threads. More...

## Detailed Description

The package BinNavi.API.debug contains classes that are used to access the available BinNavi debuggers in a platform-independent way. Using the classes of this package scripts and plugins can monitor and manipulate all aspects of target processes that are currently running in one of the BinNavi debuggers.

## Enumeration Type Documentation

enum BinNavi::API::debug::BreakpointStatus

Enumeration that contains all valid breakpoint states.

Enumerator:

  Active | Active breakpoints are those that are set in the breakpoint manager and in the target process.
  Inactive | Inactive breakpoints are those that are set in the breakpoint manager but not in the target process.
  Disabled | Disabled breakpoints are those that the user intentionally disabled in the breakpoint manager. Those breakpoints are also disabled in the target process if a target process is active.
  Hit | Hit breakpoints are those that are hit in the target process.
  Enabled | Enabled breakpoints are those that were disabled in the breakpoint manager until the user intentionally enabled them again. An enabled breakpoint quickly changes its status depending on whether a process is active or not and - if a process is active - depending on whether the breakpoint could be set in the target process or not.
  Invalid | Invalid breakpoints are those that could not be set in the target process.
  Deleting | Deleting breakpoints are those that are deleted in BinNavi but not yet in the debug client. Deleting breakpoints quickly change their state depending on the result of the breakpoint deletion in the target process.

enum BinNavi::API::debug::ThreadState

Enumeration of potential thread states.

Enumerator:

  Running | The thread is running.
  Suspended | The thread is suspended.