Interface DebugAdapter

A debug adapter that implements the Debug Adapter Protocol can be registered with the editor if it implements the DebugAdapter interface.

interface DebugAdapter {
    onDidSendMessage: Event<DebugProtocolMessage>;
    dispose(): any;
    handleMessage(message: DebugProtocolMessage): void;
}

Hierarchy (View Summary)

Disposable
- DebugAdapter

Index

Properties

onDidSendMessage

Methods

dispose handleMessage

Properties

`Readonly`onDidSendMessage

onDidSendMessage: Event<DebugProtocolMessage>

An event which fires after the debug adapter has sent a Debug Adapter Protocol message to the editor. Messages can be requests, responses, or events.

Methods

dispose

dispose(): any
Dispose this object.

Returns any
Inherited from Disposable.dispose
- Defined in vscode.d.ts:1743

handleMessage

handleMessage(message: DebugProtocolMessage): void
Handle a Debug Adapter Protocol message. Messages can be requests, responses, or events. Results or errors are returned via onSendMessage events.
Parameters
- message: DebugProtocolMessage
  A Debug Adapter Protocol message
Returns void
- Defined in vscode.d.ts:16944