Dart API

Appearance

dart:developer›Classes›Service

Service final ​

final class Service

Access information about the service protocol and control the web server that provides access to the services provided by the Dart VM for debugging and inspecting Dart programs.

Constructors ​

Service() ​

Service()

Properties ​

hashCode no setter inherited ​

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation
dart
external int get hashCode;

runtimeType no setter inherited ​

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited ​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
dart
external String toString();

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation
dart
external bool operator ==(Object other);

Static Methods ​

controlWebServer() ​

Future<ServiceProtocolInfo> controlWebServer({
  bool enable = false,
  bool? silenceOutput,
})

Control the web server that the service protocol is accessed through. enable is used as a toggle to enable or disable the web server servicing requests. If silenceOutput is provided and is true, the server will not output information to the console.

Implementation
dart
static Future<ServiceProtocolInfo> controlWebServer({
  bool enable = false,
  bool? silenceOutput,
}) async {
  &#47;&#47; Port to receive response from service isolate.
  final RawReceivePort receivePort = new RawReceivePort(
    null,
    'Service.controlWebServer',
  );
  final Completer<String?> completer = new Completer<String?>();
  receivePort.handler = (String? uriString) => completer.complete(uriString);
  &#47;&#47; Request the information from the service isolate.
  _webServerControl(receivePort.sendPort, enable, silenceOutput);
  &#47;&#47; Await the response from the service isolate.
  String? uriString = await completer.future;
  Uri? uri = uriString == null ? null : Uri.parse(uriString);
  &#47;&#47; Close the port.
  receivePort.close();
  return new ServiceProtocolInfo(uri);
}

getInfo() ​

Future<ServiceProtocolInfo> getInfo()

Get information about the service protocol (version number and Uri to access the service).

Implementation
dart
static Future<ServiceProtocolInfo> getInfo() async {
  &#47;&#47; Port to receive response from service isolate.
  final RawReceivePort receivePort = new RawReceivePort(
    null,
    'Service.getInfo',
  );
  final Completer<String?> completer = new Completer<String?>();
  receivePort.handler = (String? uriString) => completer.complete(uriString);
  &#47;&#47; Request the information from the service isolate.
  _getServerInfo(receivePort.sendPort);
  &#47;&#47; Await the response from the service isolate.
  String? uriString = await completer.future;
  Uri? uri = uriString == null ? null : Uri.parse(uriString);
  &#47;&#47; Close the port.
  receivePort.close();
  return new ServiceProtocolInfo(uri);
}

deprecated getIsolateID() ​

String? getIsolateID(Isolate isolate)

DEPRECATED

Use getIsolateId instead

Returns a String token representing the ID of isolate.

Returns null if the running Dart environment does not support the service protocol.

Implementation
dart
@Deprecated("Use getIsolateId instead")
static String? getIsolateID(Isolate isolate) {
  return _getIsolateIdFromSendPort(isolate.controlPort);
}

getIsolateId() ​

String? getIsolateId(Isolate isolate)

Returns a String token representing the ID of isolate.

Returns null if the running Dart environment does not support the service protocol.

To get the isolate id of the current isolate, pass Isolate.current as the isolate parameter.

Implementation
dart
@Since('3.2')
static String? getIsolateId(Isolate isolate) {
  return _getIsolateIdFromSendPort(isolate.controlPort);
}

getObjectId() ​

String? getObjectId(Object object)

Returns a String token representing the ID of object.

Returns null if the running Dart environment does not support the service protocol.

Implementation
dart
@Since('3.2')
static String? getObjectId(Object object) {
  return _getObjectId(object);
}