Class PluginDebugAdapterTracker

A Debug Adapter Tracker is a means to track the communication between VS Code and a Debug Adapter.

Implements

DebugAdapterTracker

Index

Constructors

Properties

Methods

onDidSendMessage onError onExit onWillReceiveMessage onWillStartSession onWillStopSession create

Constructors

constructor

new PluginDebugAdapterTracker(
trackers: DebugAdapterTracker[],
): PluginDebugAdapterTracker
Parameters
- trackers: DebugAdapterTracker[]
Returns PluginDebugAdapterTracker
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:22

Properties

`Protected` `Readonly`trackers

trackers: DebugAdapterTracker[]

Methods

onDidSendMessage

onDidSendMessage(message: any): void
The debug adapter has sent a Debug Adapter Protocol message to VS Code.
Parameters
- message: any
Returns void
Implementation of DebugAdapterTracker.onDidSendMessage
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:54

onError

onError(error: Error): void
An error with the debug adapter has occurred.
Parameters
- error: Error
Returns void
Implementation of DebugAdapterTracker.onError
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:70

onExit

onExit(code: undefined | number, signal: undefined | string): void
The debug adapter has exited with the given exit code or signal.
Parameters
- code: undefined | number
- signal: undefined | string
Returns void
Implementation of DebugAdapterTracker.onExit
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:78

onWillReceiveMessage

onWillReceiveMessage(message: any): void
The debug adapter is about to receive a Debug Adapter Protocol message from VS Code.
Parameters
- message: any
Returns void
Implementation of DebugAdapterTracker.onWillReceiveMessage
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:46

onWillStartSession

onWillStartSession(): void
A session with the debug adapter is about to be started.

Returns void
Implementation of DebugAdapterTracker.onWillStartSession
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:38

onWillStopSession

onWillStopSession(): void
The debug adapter session is about to be stopped.

Returns void
Implementation of DebugAdapterTracker.onWillStopSession
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:62

`Static`create

create(
session: DebugSession,
trackerFactories: [string, DebugAdapterTrackerFactory][],
): Promise<PluginDebugAdapterTracker>
Parameters
- session: DebugSession
- trackerFactories: [string, DebugAdapterTrackerFactory][]
Returns Promise<PluginDebugAdapterTracker>
- Defined in packages/plugin-ext/src/plugin/debug/plugin-debug-adapter-tracker.ts:24