DartDevelopmentService class abstract

An intermediary between a Dart VM service and its clients that offers additional functionality on top of the standard VM service protocol.

See the Dart Development Service Protocol for details.

Properties

authCodesEnabled → bool
Set to true if this instance of DartDevelopmentService requires an authentication code to connect.
no setter
cachedUserTags → List<String>
The list of UserTags used to determine which CPU samples are cached by DDS.
no setter
devToolsUri → Uri?
The HTTP Uri of the hosted DevTools instance.
no setter
done → Future<void>
Completes when this DartDevelopmentService has shut down.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hostedDartToolingDaemon → ({String? secret, String? uri})?
Metadata for the Dart Tooling Daemon instance that is hosted by DevTools.
no setter
isRunning → bool
Set to true if this instance of DartDevelopmentService is accepting requests.
no setter
remoteVmServiceUri → Uri
The HTTP Uri of the remote VM service instance that this service will forward requests to.
no setter
remoteVmServiceWsUri → Uri
The web socket Uri of the remote VM service instance that this service will forward requests to.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sseUri → Uri?
The Uri VM service clients can use to communicate with this DartDevelopmentService via server-sent events (SSE).
no setter
uri → Uri?
The Uri VM service clients can use to communicate with this DartDevelopmentService via HTTP.
no setter
wsUri → Uri?
The Uri VM service clients can use to communicate with this DartDevelopmentService via a WebSocket.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExternalDevToolsUri(Uri uri) → void
Registers an external DevTools server with this instance of DartDevelopmentService to allow for DDS to redirect DevTools requests to the DevTools server.
shutdown() → Future<void>
Stop accepting requests after gracefully handling existing requests.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

startDartDevelopmentService(Uri remoteVmServiceUri, {Uri? serviceUri, bool enableAuthCodes = true, bool ipv6 = false, bool enableServicePortFallback = false, List<String> cachedUserTags = const [], DevToolsConfiguration? devToolsConfiguration, bool logRequests = false, UriConverter? uriConverter}) → Future<DartDevelopmentService>
Creates a DartDevelopmentService instance which will communicate with a VM service. Requires the target VM service to have no other connected clients.

Constants

protocolVersion → const String
The version of the DDS protocol supported by this DartDevelopmentService instance.