dart-sdk/pkg/dds
Danny Tuppeny db0d9b1852 [dds] Serve DevTools index page for extension-less requests to support UrlPathStrategy
Change-Id: I780e16b391dda6159c99b4844f6663dad02a98af
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/239082
Reviewed-by: Ben Konyi <bkonyi@google.com>
Reviewed-by: Kenzie Davisson <kenzieschmoll@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>
2022-04-25 14:12:13 +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] Serve DevTools index page for extension-less requests to support UrlPathStrategy 2022-04-25 14:12:13 +00:00
test [dds] Serve DevTools index page for extension-less requests to support UrlPathStrategy 2022-04-25 14:12:13 +00:00
tool
.gitignore
analysis_options.yaml Move pkg/dds to package:lints. 2022-04-14 22:44:33 +00:00
CHANGELOG.md [ DDS ] Add R/W-like locking around streamListen and streamCancel 2022-04-04 23:16:42 +00:00
dds_protocol.md
LICENSE
OWNERS
pubspec.yaml Update the sdk lower bounds for analyzer, dds. 2022-04-20 00:10:27 +00:00
README.md

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());
}