AbstractExecutor

The base class for all executors in CAMS.

Implements the Executor state machine. Subclasses only implement the callbacks onInitialize, onResume, onPause and onDispose; the lifecycle methods themselves cannot be overridden. A synchronous exception in a lifecycle method moves the executor to ExecutorState.Undefined.

Implemented types

Executor<TConfig>

Implementers

Constructors

AbstractExecutor

AbstractExecutor<TConfig>()

Properties

configuration

@override

TConfig? get configuration

override

The configuration of this executor as set in initialize.

deployment

@override

SmartphoneDeployment? get deployment

override

The deployment that this executor is part of executing.

measurements

@override

Stream<Measurement> get measurements

override

The stream of Measurement collected by this executor.

samplingState

@override

SamplingState get samplingState

override

The runtime sampling state of this executor.

state

@override

ExecutorState get state

override

The runtime state of this executor.

stateEvents

@override

Stream<ExecutorState> get stateEvents

override

The runtime state changes of this executor.

Methods

addError

void addError(

Object error, [
StackTrace? stacktrace

])

Logs error as a warning and adds it to the measurements stream.

addMeasurement

void addMeasurement(

Measurement measurement

)

Adds measurement to the measurements stream.

dispose

@override
@nonVirtual

void dispose()

override

Disposes this executor.

If not already paused, pause will be called first.

Once disposed, the executor cannot be used anymore and nothing will happen if any of the life cycle methods are called.

error

void error()

Moves this executor to ExecutorState.Undefined.

initialize

@override
@nonVirtual

void initialize(

TConfig configuration, [
SmartphoneDeployment? deployment

])

override

Configures and initializes the executor. Call before resume.

onDispose

@protected

Future<void> onDispose()

Callback when this executor is disposed.

Subclasses should override this, to implement any cleanup to be done before disposing.

onInitialize

@protected

bool onInitialize()

Called by initialize. Returns true if successfully initialized.

If false, the executor stays in ExecutorState.Created. This is a synchronous method and must be light-weight.

onPause

@protected

Future<bool> onPause()

Called by pause. Returns true if successfully paused.

If false, the state is not changed.

onResume

@protected

Future<bool> onResume()

Called by resume. Returns true if successfully resumed.

If false, the executor moves to ExecutorState.PausedButShouldBeResumed.

pause

@override
@nonVirtual

void pause()

override

Pauses the executor until resume is called.

pauseButShouldBeResumed

@override
@nonVirtual

void pauseButShouldBeResumed()

override

Pauses the executor and marks it to be resumed later.

The state becomes ExecutorState.PausedButShouldBeResumed, e.g. when its device is temporarily disconnected.

resume

@override
@nonVirtual

void resume()

override

Starts or resumes the executor.

toString

@override

String toString()

override

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.