DartDevelopmentServiceLauncher class

Spawns a Dart Development Service instance which will communicate with a VM service. Requires the target VM service to have no other connected clients.

remoteVmServiceUri is the address of the VM service that this development service will communicate with.

If provided, serviceUri will determine the address and port of the spawned Dart Development Service.

enableAuthCodes controls whether or not an authentication code must be provided by clients when communicating with this instance of DDS. Authentication codes take the form of a base64 encoded string provided as the first element of the DDS path and is meant to make it more difficult for unintended clients to connect to this service. Authentication codes are enabled by default.

If serveDevTools is enabled, DDS will serve a DevTools instance and act as a DevTools Server. If not specified, devToolsServerAddress is ignored.

If provided, DDS will redirect DevTools requests to an existing DevTools server hosted at devToolsServerAddress. Ignored if serveDevTools is not true.

If enableServicePortFallback is enabled, DDS will attempt to bind to any available port if the specified port is unavailable.

If set, the set of cachedUserTags will be used to determine which CPU samples should be cached by DDS.

If provided, dartExecutable is the path to the 'dart' executable that should be used to spawn the DDS instance. By default, Platform.executable is used.

Properties

devToolsUri → Uri?

The HTTP Uri of the hosted DevTools instance.

final

done → Future<void>

Completes when the DDS instance has shutdown.

no setter

dtdUri → Uri?

The Uri of the Dart Tooling Daemon instance that is hosted by DevTools.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sseUri → Uri

The Uri VM service clients can use to communicate with this DDS instance via server-sent events (SSE).

no setter

uri → Uri

The Uri VM service clients can use to communicate with this DDS instance via HTTP.

final

wsUri → Uri

The Uri VM service clients can use to communicate with this DDS instance via a WebSocket.

no setter

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

shutdown() → Future<void>

Shutdown the DDS instance.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

start({required Uri remoteVmServiceUri, Uri? serviceUri, bool enableAuthCodes = true, bool serveDevTools = false, Uri? devToolsServerAddress, bool enableServicePortFallback = false, List<String> cachedUserTags = const <String>[], String? dartExecutable, Uri? google3WorkspaceRoot}) → Future<DartDevelopmentServiceLauncher>