AppTaskExecutor class

Executes an AppTask.

An AppTaskExecutor simply wraps a TaskExecutor, which is executed when the app (user) wants to do this.

This executor works closely with the singleton AppTaskController. Whenever an AppTaskExecutor is resumed (e.g. in a PeriodicTrigger), this executor is wrapped in a UserTask and put on a queue in the AppTaskController.

Later, the app (user) can start, pause, or finalize a UserTask by calling the onStart(), onHold(), and onDone() methods, respectively.

Special-purpose UserTask can be created by an UserTaskFactory and such factories can be registered in the AppTaskController using the registerUserTaskFactory method.

Inheritance

Constructors

AppTaskExecutor(AppTask task)

Properties

appTask AppTask
The AppTask to be executed.
read / write
data Stream<DataPoint>
The stream of DataPoint generated from this probe.
read-only, inherited
enabled bool
Is this probe enabled, i.e. available for collection of data using the resume method.
read-only, inherited
executors List<Probe>
read / write, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
measure Measure
The Measure that configures this probe.
read-only, inherited
name String
A printer-friendly name for this probe.
read-only, inherited
probes List<Probe>
Returns a list of the running probes in this task executor.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
state ProbeState
The runtime state of this probe.
read-only, inherited
stateEvents Stream<ProbeState>
The runtime state changes of this probe. [...]
read-only, inherited
task TaskDescriptor
read-only, inherited
type String
The type of this probe according to String.
read-only, inherited

Methods

error() → void
inherited
hasChanged(Measure measure) → void
Callback when this probe's measure has changed.
inherited
initialize(Measure measure) → void
Initialize the probe before starting it. [...]
inherited
mark() → void
Mark the latest sampling
@protected, inherited
marking() → void
Get the latest mark
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
onInitialize(Measure measure) → void
Callback for initialization of probe. [...]
override
onPause() Future
Callback for pausing probe
override
onRestart({Measure measure}) Future
Callback for restarting probe
inherited
onResume() Future
Callback for resuming probe
override
onStop() Future
Callback for stopping probe
override
pause() → void
Pause the probe. The probe is paused until resume or restart is called.
inherited
restart() → void
Restart the probe. [...]
inherited
resume() → void
Resume the probe.
inherited
stop() → void
Stop the probe. Once a probe is stopped, it cannot be started again. If you need to restart a probe, use the restart or pause and resume methods.
inherited
toString() String
A string representation of this object. [...]
inherited
validNextState(ProbeState nextState) bool
Is ProbeState a valid next state for this probe? [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited