AppTaskExecutor<TConfig extends AppTask> 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 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<
TaskDescriptor> -
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
-
data
→ Stream<
DataPoint> -
The stream of
DataPoint
generated from this executor.no setterinherited - deployment → SmartphoneDeployment?
-
The deployment that this executor is part of executing.
no setterinherited
-
executors
→ List<
Executor> -
finalinherited
-
group
→ StreamGroup<
DataPoint> -
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
probes
→ List<
Probe> -
Returns a list of the running 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
- task → TConfig
-
no setterinherited
Methods
-
error(
) → void -
inherited
-
initialize(
TConfig configuration, [SmartphoneDeployment? deployment]) → void -
Configure and initialize the executor before resuming it.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onInitialize(
) → bool -
Callback when this executor is initialized.
Returns true if succesfully initialized, false othervise.
override
-
onPause(
) → Future< bool> -
Callback when this executor is paused.
Returns true if successfully paused, false otherwise.
override
-
onRestart(
) → Future< bool> -
Callback when this executor is restarted.
Returns true if successfully restarted, false otherwise.
inherited
-
onResume(
) → Future< bool> -
Callback when this executor is resumed.
Returns true if successfully resumed, false otherwise.
override
-
onStop(
) → Future< bool> -
Callback when this executor is stopped.
Returns true if successfully stopped, false otherwise.
override
-
pause(
) → void -
Pause the executor. Paused until resume or stop is called.
inherited
-
restart(
) → void -
Restart the executor.
inherited
-
resume(
) → void -
Resume the executor.
inherited
-
stop(
) → void -
Stop the executor. Once an executor is stopped, it cannot be resumed again.
If you need to restart an executor, use the restart or pause and
resume methods.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited