dart-sdk/pkg/dds
Danny Tuppeny 1cc4c11257 Add changelog for DAP classes + some docs on DAP
Change-Id: Ic74f02ec29b45c70dcf71f5d395d2bf80b85a269
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/215552
Reviewed-by: Ben Konyi <bkonyi@google.com>
2021-10-06 12:54:18 +00:00
..
bin [ CLI ] Fix IPv6 VM service support for standalone VM 2021-06-24 19:50:59 +00:00
example Reland "[ package:dds ] Add null safety support" 2021-05-24 16:59:23 +00:00
lib Add changelog for DAP classes + some docs on DAP 2021-10-06 12:54:18 +00:00
test [dds] Add some basic test reporting for DAP test adapter 2021-10-01 16:31:34 +00:00
tool/dap Add changelog for DAP classes + some docs on DAP 2021-10-06 12:54:18 +00:00
.gitignore
analysis_options.yaml replace copied code with references to package:devtools_shared 2021-07-12 17:55:04 +00:00
CHANGELOG.md Add changelog for DAP classes + some docs on DAP 2021-10-06 12:54:18 +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
pubspec.yaml Add changelog for DAP classes + some docs on DAP 2021-10-06 12:54:18 +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());
}