dart-sdk/pkg/dds
Danny Tuppeny 84f528d26d [dds/dap] Handle "Service has disappeared" errors for in-flight requests when app may be shutting down
Fixes https://github.com/flutter/flutter/issues/116235.

Change-Id: Ibfd24bce45519116e350a7f409609f19ca502ad3
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/303580
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>
2023-05-16 14:44:23 +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 [dds/dap] Handle "Service has disappeared" errors for in-flight requests when app may be shutting down 2023-05-16 14:44:23 +00:00
test [dds/dap] Handle "Service has disappeared" errors for in-flight requests when app may be shutting down 2023-05-16 14:44:23 +00:00
tool [pkg/dds] use package:lints/recommended.yaml 2023-02-21 18:30:23 +00:00
.gitignore
analysis_options.yaml [pkg/dds] use package:lints/recommended.yaml 2023-02-21 18:30:23 +00:00
CHANGELOG.md [dds/dap] Handle "Service has disappeared" errors for in-flight requests when app may be shutting down 2023-05-16 14:44:23 +00:00
dds_protocol.md [DDS] Add getPerfettoVMTimelineWithCpuSamples RPC 2023-05-04 20:23:09 +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 [dds/dap] Handle "Service has disappeared" errors for in-flight requests when app may be shutting down 2023-05-16 14:44:23 +00:00
README.md Fix typos 2022-07-12 19:35:22 +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());
}