dart-sdk/pkg/dds
Ben Konyi d087f0334d [ DDS ] Fix devtools_server tests on Windows
Fixes https://github.com/dart-lang/sdk/issues/48528

Change-Id: Iaa08d6ee409354eadc37d3beb98ea79b75575758
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/239464
Reviewed-by: Kenzie Davisson <kenzieschmoll@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>
2022-03-30 20:45:20 +00:00
..
bin Reland "[ Service / DDS ] Remove VM service polling logic, add --enable-service-fallback-port support to DDS" 2022-03-15 18:14:42 +00:00
example
lib [dds] Fix deserialisation of env vars in DAP 2022-03-29 18:39:29 +00:00
test [ DDS ] Fix devtools_server tests on Windows 2022-03-30 20:45:20 +00:00
tool Add a script to serve a local DevTools build 2022-02-03 18:03:18 +00:00
.gitignore
analysis_options.yaml [dds] Attach file/line/col metadata to DAP OutputEvents for detected call stacks 2022-01-18 18:26:05 +00:00
CHANGELOG.md [ package:dds ] Migrate package:devtools_server functionality under package:dds/devtools_server.dart 2022-01-18 22:42:05 +00:00
dds_protocol.md master branch to main 2021-09-15 06:22:23 +00:00
LICENSE
OWNERS [infra] Add OWNERS to the Dart SDK 2022-02-14 14:06:34 +00:00
pubspec.yaml Reland "Add DevTools Server test and test driver to DDS" 2022-03-09 16:48:54 +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());
}