dart-sdk/pkg/dds
Helin Shiah 7f098b4cf5 Update vm service version for DDS
Change-Id: Ie26f64d629c0d1a319f90e2d0eb3b22caa981c93
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/248360
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>
2022-06-14 16:37:57 +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] Handle methodNotFound errors for setLibraryDebuggable for DWDS 2022-06-14 16:36:47 +00:00
test [ package:dds ] Migrate devtools_observatory_connection_test to null safety 2022-06-07 14:49:09 +00:00
tool Fix typos 2022-05-24 09:10:51 +00:00
.gitignore
analysis_options.yaml Move pkg/dds to package:lints. 2022-04-14 22:44:33 +00:00
CHANGELOG.md Update vm service version for DDS 2022-06-14 16:37:57 +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 Update vm service version for DDS 2022-06-14 16:37:57 +00:00
README.md [pkg] normalize the headers of the pkg/ readmes 2022-05-31 21:00:13 +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 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());
}