AppTaskExecutor<TConfig extends AppTask> class
Executes an AppTask.
An AppTaskExecutor wraps a BackgroundTaskExecutor, which is started by the app (user) and starts collecting the measures defined in this task.
This executor works closely with the singleton AppTaskController. Whenever an AppTaskExecutor is started (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, cancel, or finalize a UserTask
by calling the onStart()
, onCancel()
, and onDone()
methods,
respectively.
Special-purpose UserTasks can be created by an UserTaskFactory
and such factories can be registered in the AppTaskController
using the registerUserTaskFactory
method.
- Inheritance
-
- Object
- AbstractExecutor<
TConfig> - AggregateExecutor<
TConfig> - TaskExecutor<
TConfig> - AppTaskExecutor
Constructors
Properties
-
backgroundTaskExecutor
↔ TaskExecutor<
TaskConfiguration> -
The task executor which can be used to execute this user task once
activated.
getter/setter pair
- configuration → TConfig?
-
The configuration of this executor as set when initialized.
no setterinherited
- deployment → SmartphoneDeployment?
-
The deployment that this executor is part of executing.
no setterinherited
-
executors
→ List<
Executor> -
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isStarting → bool
-
Is this executor in the process of being started?
no setterinherited
-
measurements
→ Stream<
Measurement> -
The stream of
Measurement
collected by this executor.no setterinherited -
probes
→ List<
Probe> -
Returns a list of the probes in this task executor.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → ExecutorState
-
The runtime state of this executor.
no setterinherited
-
stateEvents
→ Stream<
ExecutorState> -
The runtime state changes of this executor.
no setterinherited
-
states
→ Stream<
ExecutorState> -
The combines state event from all probes in this task executor.
no setterinherited
- task → TConfig
-
The
TaskConfiguration
for this task executor.no setterinherited - userTask ↔ UserTask?
-
The user task enqueued when this app task executor is started.
Null if not started, or stopped again.
getter/setter pair
Methods
-
addError(
Object error, [StackTrace? stacktrace]) → void -
Add an error to the measurements stream.
inherited
-
addExecutor(
Executor executor) → void -
Add the
executor
to the list of executors and forwards its measurements to this aggregate executor's stream of measurements.inherited -
addMeasurement(
Measurement measurement) → void -
Add a data point to the measurements stream.
inherited
-
dispose(
) → void -
Dispose of this executor.
inherited
-
error(
) → void -
inherited
-
initialize(
TConfig configuration, [SmartphoneDeployment? deployment]) → void -
Configure and initialize the executor before starting it.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onDispose(
) → Future< void> -
Callback when this executor is disposed.
inherited
-
onInitialize(
) → bool -
Callback when this executor is initialized.
Returns true if successfully initialized, false otherwise.
override
-
onRestart(
) → Future< bool> -
Callback when this executor is to be restarted.
Returns true if the executor is ready to restart (default), false otherwise.
inherited
-
onStart(
) → Future< bool> -
Callback when this executor is started.
Returns true if successfully started, false otherwise.
override
-
onStop(
) → Future< bool> -
Callback when this executor is stopped.
Returns true if successfully stopped, false otherwise.
override
-
removeExecutor(
Executor executor) → void -
Remove the
executor
to the list of executors.inherited -
restart(
) → void -
Restart the executor.
inherited
-
start(
) → void -
Start the executor.
inherited
-
stop(
) → void -
Stop the executor. Stopped until start or restart is called.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited