BufferingPeriodicProbe class abstract
A probe that collects data in sampling windows, one measurement per window.
Uses a PeriodicSamplingConfiguration: every PeriodicSamplingConfiguration.interval it calls onSamplingStart, and after PeriodicSamplingConfiguration.duration it calls onSamplingEnd and adds the result of getMeasurement. On pause, any buffered data is collected with getMeasurement too.
- Inheritance
-
- Object
- AbstractExecutor<
Measure> - Probe
- MeasurementProbe
- BufferingPeriodicProbe
Constructors
Properties
- configuration → Measure?
-
The configuration of this executor as set in initialize.
no setterinherited
- deployment → SmartphoneDeployment?
-
The deployment that this executor is part of executing.
no setterinherited
-
deviceManager
↔ DeviceManager<
DeviceConfiguration< DeviceRegistration> , DeviceRegistration> -
The device manager of the device this probe collects data from.
getter/setter pairinherited
- enabled ↔ bool
-
Whether this probe is enabled.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- measure → Measure?
-
The
Measurethat configures this probe.no setterinherited -
measurements
→ Stream<
Measurement> -
The stream of
Measurementcollected by this executor.no setterinherited -
permissions
→ List<
Permission> -
The permissions this probe needs. Empty if none.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- samplingConfiguration → PeriodicSamplingConfiguration?
-
The sampling configuration for this probe.
no setteroverride
- samplingState → SamplingState
-
The runtime sampling state of this executor.
no setterinherited
- state → ExecutorState
-
The runtime state of this executor.
no setterinherited
-
stateEvents
→ Stream<
ExecutorState> -
The runtime state changes of this executor.
no setterinherited
- timer ↔ Timer?
-
The timer that starts each sampling window.
getter/setter pair
- type → String?
-
The data type this probe collects, e.g.
dk.cachet.carp.steps.no setterinherited
Methods
-
addError(
Object error, [StackTrace? stacktrace]) → void -
Logs
erroras a warning and adds it to the measurements stream.inherited -
addMeasurement(
Measurement measurement) → void -
Adds
measurementto measurements.inherited -
arePermissionsGranted(
) → Future< bool> -
Whether all permissions are granted. Returns false if checking fails.
inherited
-
dispose(
) → void -
Disposes this executor.
inherited
-
error(
) → void -
Moves this executor to ExecutorState.Undefined.
inherited
-
getMeasurement(
) → Future< Measurement?> -
Returns the
Measurementfor the last sampling window.override -
hasRequiredPermissions(
) → Future< bool> -
Whether this probe is allowed to run.
inherited
-
initialize(
Measure configuration, [SmartphoneDeployment? deployment]) → void -
Configures and initializes the executor. Call before resume.
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 -
Called by initialize. Returns true if successfully initialized.
inherited
-
onPause(
) → Future< bool> -
Called by pause. Returns true if successfully paused.
override
-
onResume(
) → Future< bool> -
Called by resume. Returns true if successfully resumed.
override
-
onSamplingEnd(
) → void - Handler called when sampling period ends.
-
onSamplingStart(
) → void - Handler called when sampling period starts.
-
pause(
) → void -
Pauses the executor until resume is called.
inherited
-
pauseButShouldBeResumed(
) → void -
Pauses the executor and marks it to be resumed later.
inherited
-
requestPermissions(
) → Future< bool> -
Asks the user for any permissions not yet granted.
inherited
-
resume(
) → void -
Starts or resumes the executor.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited