dart-sdk/pkg/dds
Elliott Brooks 2943f4399e Update DDS CONTRIBUTING docs
Change-Id: Ia92b06a5f18eb3e090157d4df5f509297b70958c
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/374121
Reviewed-by: Kenzie Davisson <kenzieschmoll@google.com>
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Elliott Brooks <elliottbrooks@google.com>
2024-07-03 21:02:46 +00:00
..
bin [ DDS ] Refactor DDS entrypoint to allow for overriding behavior in google3 2024-06-13 20:27:22 +00:00
example
lib [ DDS ] Remove extra stderr.close() 2024-06-17 14:44:22 +00:00
test Revert "Reapply "[ Service ] Start DDS and serve DevTools when the VM service is started via dart:developer"" 2024-07-01 18:30:28 +00:00
tool/devtools_server [dds] Remove copy of dap tool 2024-01-09 10:45:30 +00:00
.gitignore
analysis_options.yaml [pkg] remove duplicate config from the analysis options files 2023-11-14 00:37:53 +00:00
CHANGELOG.md [ package:dds ] Update CHANGELOG and pubspec to 4.2.4+1 (republished 4.2.4) 2024-06-24 14:13:55 +00:00
CONTRIBUTING.md Update DDS CONTRIBUTING docs 2024-07-03 21:02:46 +00:00
dds_protocol.md [ DDS ] Rework client resume permissions API 2024-03-21 21:09:42 +00:00
LICENSE
OWNERS
pubspec.yaml [ package:dds ] Update CHANGELOG and pubspec to 4.2.4+1 (republished 4.2.4) 2024-06-24 14:13:55 +00:00
README.md Improve documentation for DDS and DTD 2024-04-04 15:50:02 +00:00

pub package package publisher

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 preferable or required to communicate with DDS using server-sent events (SSE). DDS has an 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());
}