dart-sdk/pkg/dds
Devon Carew 169365f953 Move pkg/dds to package:lints.
Change-Id: I614a826569fee248b72f973a863e758949c04932
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/241146
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Devon Carew <devoncarew@google.com>
2022-04-14 22:44:33 +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 Reland "[ package:dds ] Add null safety support" 2021-05-24 16:59:23 +00:00
lib Move pkg/dds to package:lints. 2022-04-14 22:44:33 +00:00
test Move pkg/dds to package:lints. 2022-04-14 22:44:33 +00:00
tool Add a script to serve a local DevTools build 2022-02-03 18:03:18 +00:00
.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 master branch to main 2021-09-15 06:22:23 +00:00
LICENSE Update LICENSE 2021-04-07 10:28:38 +00:00
OWNERS [infra] Add OWNERS to the Dart SDK 2022-02-14 14:06:34 +00:00
pubspec.yaml Move pkg/dds to package:lints. 2022-04-14 22:44:33 +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());
}