getInboundReferences method

Future<InboundReferences> getInboundReferences(
  1. String isolateId,
  2. String targetId,
  3. int limit, {
  4. String? idZoneId,
})

Returns a set of inbound references to the object specified by targetId. Up to limit references will be returned.

If idZoneId is provided, temporary IDs for InstancesRef and Instances in the RPC response will be allocated in the specified ID zone. If idZoneId is omitted, ID allocations will be performed in the default ID zone for the isolate. See IDs and Names for more information about ID zones.

The order of the references is undefined (i.e., not related to allocation order) and unstable (i.e., multiple invocations of this method against the same object can give different answers even if no Dart code has executed between the invocations).

The references may include multiple objectIds that designate the same object.

The references may include objects that are unreachable but have not yet been garbage collected.

If targetId is a temporary id which has expired, then the Expired Sentinel is returned.

If targetId refers to an object which has been collected by the VM's garbage collector, then the Collected Sentinel is returned.

If isolateId refers to an isolate which has exited, then the Collected Sentinel is returned.

See InboundReferences.

This method will throw a SentinelException in the case a Sentinel is returned.

Implementation

Future<InboundReferences> getInboundReferences(
  String isolateId,
  String targetId,
  int limit, {
  String? idZoneId,
}) =>
    _call('getInboundReferences', {
      'isolateId': isolateId,
      'targetId': targetId,
      'limit': limit,
      if (idZoneId != null) 'idZoneId': idZoneId,
    });