IntervalProbe class abstract

A probe which is triggered at regular intervals, specified by the interval property in an IntervalSamplingConfiguration. When triggered, the probe collect a measurement using the getMeasurement method.

See MemoryProbe for an example.

Inheritance
Implementers

Constructors

IntervalProbe()

Properties

configuration → Measure?
The configuration of this executor as set when initialized.
no setterinherited
deployment SmartphoneDeployment?
The deployment that this executor is part of executing.
no setterinherited
deviceManager DeviceManager<DeviceConfiguration<DeviceRegistration>>
A stream controller to add Measurements to. The device that this probes uses to collect data.
getter/setter pairinherited
enabled bool
Is this probe enabled, i.e. available for collection of data using the start method.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
isStarting bool
Is this executor in the process of being started?
no setterinherited
measure → Measure?
The Measure that configures this probe.
no setterinherited
measurements Stream<Measurement>
The stream of Measurement collected by this executor.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
samplingConfiguration IntervalSamplingConfiguration?
The sampling configuration for this probe.
no setteroverride
state ExecutorState
The runtime state of this executor.
no setterinherited
stateEvents Stream<ExecutorState>
The runtime state changes of this executor.
no setterinherited
type String?
The data type this probe is collecting.
no setterinherited

Methods

addError(Object error, [StackTrace? stacktrace]) → void
Add an error to the measurements stream.
inherited
addMeasurement(Measurement measurement) → void
Add a data point to the measurements stream.
inherited
dispose() → void
Dispose of this executor.
inherited
error() → void
inherited
getMeasurement() Future<Measurement?>
Subclasses should implement this method to collect a Measurement.
inherited
initialize(Measure 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.
inherited
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
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