Class SocketDebugAdapter

Implementers stand for the various types of debug adapters the system can talk to. Creation of debug adapters is not covered in this interface, but handling communication and the end of life is.

Hierarchy

StreamDebugAdapter
- SocketDebugAdapter

Implements

DebugAdapter

Index

Constructors

constructor

new SocketDebugAdapter(socket: Socket): SocketDebugAdapter
Parameters
- socket: Socket
Returns SocketDebugAdapter
Overrides StreamDebugAdapter.constructor
- Defined in packages/debug/src/node/stream-debug-adapter.ts:116

Properties

`Protected` `Readonly`disposables

disposables: Disposable[]

onClose

onClose: Event<void> = ...

The connection to the debug adapter has been lost. This signals the end of life for this debug adapter instance.

`Protected` `Readonly`onDisposeEmitter

onDisposeEmitter: Emitter<void>

onError

onError: Event<Error> = ...

An error has occurred communicating with the debug adapter. This does not meant the debug adapter has terminated.

onMessageReceived

onMessageReceived: Event<string> = ...

A DAP protocol message has been received from the debug adapter

Accessors

disposed

get disposed(): boolean
Returns boolean
Inherited from StreamDebugAdapter.disposed
- Defined in packages/core/lib/common/disposable.d.ts:52

onDispose

get onDispose(): Event<void>
This event is fired only once on first dispose of not empty collection.

Returns Event<void>
Inherited from StreamDebugAdapter.onDispose
- Defined in packages/core/lib/common/disposable.d.ts:50

Methods

`Protected`checkDisposed

checkDisposed(): void
Returns void
Inherited from StreamDebugAdapter.checkDisposed
- Defined in packages/core/lib/common/disposable.d.ts:51

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from StreamDebugAdapter.dispose
- Defined in packages/core/lib/common/disposable.d.ts:54

handleClosed

handleClosed(): void
Returns void
Inherited from StreamDebugAdapter.handleClosed
- Defined in packages/debug/src/node/stream-debug-adapter.ts:47

`Protected`handleData

handleData(data: Buffer): void
Parameters
- data: Buffer
Returns void
Inherited from StreamDebugAdapter.handleData
- Defined in packages/debug/src/node/stream-debug-adapter.ts:57

push

push(disposable: Disposable): Disposable
Parameters
- disposable: Disposable
Returns Disposable
Inherited from StreamDebugAdapter.push
- Defined in packages/core/lib/common/disposable.d.ts:55

pushAll

pushAll(disposables: Disposable[]): Disposable[]
Parameters
- disposables: Disposable[]
Returns Disposable[]
Inherited from StreamDebugAdapter.pushAll
- Defined in packages/core/lib/common/disposable.d.ts:56

send

send(message: string): void
Send a DAP message to the debug adapter
Parameters
- message: string
  the JSON-encoded DAP message
Returns void
Implementation of DebugAdapter.send
Inherited from StreamDebugAdapter.send
- Defined in packages/debug/src/node/stream-debug-adapter.ts:51

stop

stop(): Promise<void>
Terminate the connection to the debug adapter.

Returns Promise<void>
Implementation of DebugAdapter.stop
- Defined in packages/debug/src/node/stream-debug-adapter.ts:121

Class SocketDebugAdapter

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SocketDebugAdapter

Properties

Protected Readonlydisposables

onClose

Protected ReadonlyonDisposeEmitter

onError

onMessageReceived

Accessors

disposed

Returns boolean

onDispose

Returns Event<void>

Methods

ProtectedcheckDisposed

Returns void

dispose

Returns void

handleClosed

Returns void

ProtectedhandleData

Parameters

Returns void

push

Parameters

Returns Disposable

pushAll

Parameters

Returns Disposable[]

send

Parameters

Returns void

stop

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`disposables

`Protected` `Readonly`onDisposeEmitter

`Protected`checkDisposed

`Protected`handleData