TimelineTask final

final class TimelineTask

An asynchronous task on the timeline. An asynchronous task can have many (nested) synchronous operations. Synchronous operations can live longer than the current isolate event. To pass a TimelineTask to another isolate, you must first call pass to get the task id and then construct a new TimelineTask in the other isolate.

Constructors

TimelineTask()

TimelineTask({TimelineTask? parent, String? filterKey})

Create a task. The task ID will be set by the system.

If parent is provided, the parent's task ID is provided as argument 'parentId' when start is called. In DevTools, this argument will result in this TimelineTask being linked to the parent TimelineTask.

If filterKey is provided, a property named filterKey will be inserted into the arguments of each event associated with this task. The filterKey will be set to the value of filterKey.

Implementation

TimelineTask({TimelineTask? parent, String? filterKey})
  : _parent = parent,
    _filterKey = filterKey,
    _taskId = _getNextTaskId() {}

TimelineTask.withTaskId()

TimelineTask.withTaskId(int taskId, {String? filterKey})

Create a task with an explicit taskId. This is useful if you are passing a task from one isolate to another.

Important note: only provide task IDs which have been obtained as a result of invoking TimelineTask.pass. Specifying a custom ID can lead to ID collisions, resulting in incorrect rendering of timeline events.

If filterKey is provided, a property named filterKey will be inserted into the arguments of each event associated with this task. The filterKey will be set to the value of filterKey.

Implementation

TimelineTask.withTaskId(int taskId, {String? filterKey})
  : _parent = null,
    _filterKey = filterKey,
    _taskId = taskId {}

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

external int get hashCode;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

finish()

void finish({Map<dynamic, dynamic>? arguments})

Finish the last synchronous operation that was started. Optionally takes a Map of arguments.

Implementation

void finish({Map? arguments}) {
  if (!_hasTimeline) {
    return;
  }
  if (_stack.length == 0) {
    throw new StateError('Uneven calls to start and finish');
  }
  if (_filterKey != null) {
    arguments ??= {};
    arguments[_kFilterKey] = _filterKey;
  }
  // Pop top item off of stack.
  var block = _stack.removeLast();
  if (block == null) {
    // Dart stream was disabled when start was called.
    return;
  }
  block._finish(arguments);
}

instant()

void instant(String name, {Map<dynamic, dynamic>? arguments})

Emit an instant event for this task. Optionally takes a Map of arguments.

Implementation

void instant(String name, {Map? arguments}) {
  if (!_hasTimeline) return;
  if (!_isDartStreamEnabled()) {
    // Stream is disabled.
    return;
  }
  final instantArguments = {
    ...?arguments,
    if (_filterKey != null) _kFilterKey: _filterKey,
  };
  _reportTaskEvent(
    _taskId,
    /*flowId=*/ _noFlowId,
    _asyncInstant,
    name,
    _argumentsAsJson(instantArguments),
  );
}

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:

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:

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

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

pass()

int pass()

Retrieve the TimelineTask's task id. Will throw an exception if the stack is not empty.

Implementation

int pass() {
  if (_stack.length > 0) {
    throw new StateError(
      'You cannot pass a TimelineTask without finishing all started '
      'operations',
    );
  }
  int r = _taskId;
  return r;
}

start()

void start(String name, {Map<dynamic, dynamic>? arguments})

Start a synchronous operation within this task named name. Optionally takes a Map of arguments.

Implementation

void start(String name, {Map? arguments}) {
  if (!_hasTimeline) return;
  if (!_isDartStreamEnabled()) {
    // Push a null onto the stack and return.
    _stack.add(null);
    return;
  }
  final block = _AsyncBlock._(name, _taskId);
  _stack.add(block);
  block._start({
    ...?arguments,
    if (_parent != null) 'parentId': _parent._taskId.toRadixString(16),
    if (_filterKey != null) _kFilterKey: _filterKey,
  });
}

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

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

external bool operator ==(Object other);