dart-sdk/pkg/dds
Danny Tuppeny 4389cf7bba [dds] Add support for services/service extensions to DAP
Change-Id: I4f63fd60bf2128c8e88c999c0963b8a1e5304178
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/214281
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>
2021-09-24 11:53:15 +00:00
..
bin
example
lib [dds] Add support for services/service extensions to DAP 2021-09-24 11:53:15 +00:00
test [dds] Add support for services/service extensions to DAP 2021-09-24 11:53:15 +00:00
tool/dap [dartdev] Add a "dart debug_adapter" command to run the DAP server from DDS 2021-09-17 16:09:49 +00:00
.gitignore
analysis_options.yaml
CHANGELOG.md [ package:dds ] Silently handle exceptions raised within RPC request 2021-09-01 23:16:07 +00:00
dds_protocol.md master branch to main 2021-09-15 06:22:23 +00:00
LICENSE
pubspec.yaml [ package:dds ] Silently handle exceptions raised within RPC request 2021-09-01 23:16:07 +00:00
README.md master branch to main 2021-09-15 06:22:23 +00:00

A package used to spawn the Dart Developer Service (DDS), which is used to communicate with a Dart VM Service instance and provide extended functionality to the core VM Service Protocol.

Functionality

Existing VM Service clients can issue both HTTP, websocket, and SSE requests to a running DDS instance as if it were an instance of the VM Service itself. If a request corresponds to an RPC defined in the VM Service Protocol, DDS will forward the request and return the response from the VM Service. Requests corresponding to an RPC defined in the DDS Protocol will be handled directly by the DDS instance.

SSE Support

For certain web clients it may be preferrable or required to communicate with DDS using server-sent events (SSE). DDS has a SSE handler listening for requests on /$debugHandler.

SSE and package:vm_service example

import 'package:sse/sse.dart';
import 'package:vm_service/vm_service.dart';

void main() {
  // Establish connection with DDS using SSE.
  final ddsChannel = SseClient('${ddsUri}\$debugHandler');

  // Wait for ddsChannel to be established
  await ddsChannel.onOpen.first;

  // Initialize VmService using the sink and stream from ddsChannel.
  final vmService = VmService(
    ddsChannel.stream,
    (e) => ddsChannel.sink.add(e),
  );

  // You're ready to query DDS and the VM service!
  print(await vmService.getVersion());
}