6de68d541a
service connection loss could result in a null JSON RPC response. This would cause package:vm_service to throw a NoSuchMethodError as it currently assumes it will never receive a null result in a JSON RPC response. Related to https://github.com/flutter/flutter/issues/74051. Change-Id: I86c1c9f7e46e34519f32dfed589c6b31aed39d7f Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/179800 Reviewed-by: Zach Anderson <zra@google.com> Commit-Queue: Ben Konyi <bkonyi@google.com> |
||
---|---|---|
.. | ||
bin | ||
example | ||
lib | ||
test | ||
.gitignore | ||
analysis_options.yaml | ||
CHANGELOG.md | ||
dds_protocol.md | ||
LICENSE | ||
pubspec.yaml | ||
README.md |
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());
}