Class PluginDebugAdapterSession

Server debug adapter session.

Hierarchy (View Summary)

DebugAdapterSessionImpl
- PluginDebugAdapterSession

Implements

DebugSession

Index

Constructors

constructor

new PluginDebugAdapterSession(
    debugAdapter: DebugAdapter,
    tracker: DebugAdapterTracker,
    theiaSession: DebugSession,
): PluginDebugAdapterSession
Parameters
- debugAdapter: DebugAdapter
- tracker: DebugAdapterTracker
- theiaSession: DebugSession
Returns PluginDebugAdapterSession
Overrides DebugAdapterSessionImpl.constructor
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:29

Properties

`Readonly`debugAdapter

debugAdapter: DebugAdapter

`Readonly`id

id: string

The unique ID of this debug session.

`Protected` `Readonly`theiaSession

theiaSession: DebugSession

`Protected` `Readonly`tracker

tracker: DebugAdapterTracker

Accessors

configuration

get configuration(): DebugConfiguration
The "resolved" debug configuration of this session.

Returns DebugConfiguration
Implementation of DebugSession.configuration
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:50

name

get name(): string
The debug session's name from the debug configuration.

Returns string
Implementation of DebugSession.name
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:44

parentSession

get parentSession(): undefined | DebugSession
The parent session of this debug session, if it was created as a child.

Returns undefined | DebugSession
See
DebugSessionOptions.parentSession
Implementation of DebugSession.parentSession
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:37

type

get type(): string
The debug session's type from the debug configuration.

Returns string
Implementation of DebugSession.type
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:41

workspaceFolder

get workspaceFolder(): undefined | WorkspaceFolder
The workspace folder of this session or undefined for a folderless setup.

Returns undefined | WorkspaceFolder
Implementation of DebugSession.workspaceFolder
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:47

Methods

customRequest

customRequest(command: string, args?: any): Promise<any>
Send a custom request to the debug adapter.
Parameters
- command: string
- Optionalargs: any
Returns Promise<any>
Implementation of DebugSession.customRequest
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:68

getDebugProtocolBreakpoint

getDebugProtocolBreakpoint(
breakpoint: Breakpoint,
): Promise<undefined | DebugProtocolBreakpoint>
Maps a breakpoint in the editor to the corresponding Debug Adapter Protocol (DAP) breakpoint that is managed by the debug adapter of the debug session. If no DAP breakpoint exists (either because the editor breakpoint was not yet registered or because the debug adapter is not interested in the breakpoint), the value undefined is returned.
Parameters
- breakpoint: Breakpoint
  a Breakpoint in the editor.
Returns Promise<undefined | DebugProtocolBreakpoint>
Implementation of DebugSession.getDebugProtocolBreakpoint
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:72

`Protected`onDebugAdapterError

onDebugAdapterError(error: Error): void
Parameters
- error: Error
Returns void
Overrides DebugAdapterSessionImpl.onDebugAdapterError
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:76

`Protected`onDebugAdapterExit

onDebugAdapterExit(): void
Returns void
Overrides DebugAdapterSessionImpl.onDebugAdapterExit
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:100

`Protected`send

send(message: string): void
Parameters
- message: string
Returns void
Overrides DebugAdapterSessionImpl.send
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:83

start

start(channel: DebugChannel): Promise<void>
Parameters
- channel: DebugChannel
Returns Promise<void>
Overrides DebugAdapterSessionImpl.start
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:54

stop

stop(): Promise<void>
Returns Promise<void>
Overrides DebugAdapterSessionImpl.stop
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:61

`Protected`write

write(message: string): void
Parameters
- message: string
Returns void
Overrides DebugAdapterSessionImpl.write
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-session.ts:93

Class PluginDebugAdapterSession

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PluginDebugAdapterSession

Properties

ReadonlydebugAdapter

Readonlyid

Protected ReadonlytheiaSession

Protected Readonlytracker

Accessors

configuration

Returns DebugConfiguration

name

Returns string

parentSession

Returns undefined | DebugSession

See

type

Returns string

workspaceFolder

Returns undefined | WorkspaceFolder

Methods

customRequest

Parameters

Returns Promise<any>

getDebugProtocolBreakpoint

Parameters

Returns Promise<undefined | DebugProtocolBreakpoint>

ProtectedonDebugAdapterError

Parameters

Returns void

ProtectedonDebugAdapterExit

Returns void

Protectedsend

Parameters

Returns void

start

Parameters

Returns Promise<void>

stop

Returns Promise<void>

Protectedwrite

Parameters

Returns void

Settings

On This Page

`Readonly`debugAdapter

`Readonly`id

`Protected` `Readonly`theiaSession

`Protected` `Readonly`tracker

`Protected`onDebugAdapterError

`Protected`onDebugAdapterExit

`Protected`send

`Protected`write