BufferingPeriodicProbe class Null safety

An abstract probe which can be used to sample data into a buffer, every frequency for a period of duration. These events are buffered, and once collected for the duration, are collected from the getDatum method and send to the main data stream.

When sampling starts, the onSamplingStart handle is called. When the sampling window ends, the onSamplingEnd handle is called.

See AudioProbe for an example.

Inheritance

Constructors

BufferingPeriodicProbe()

Properties

controller StreamController<Datum>
read / write, inherited
data Stream<DataPoint>
The stream of DataPoint generated from this probe.
read-only, inherited
duration Duration?
read / write
enabled bool
Is this probe enabled, i.e. available for collection of data using the resume method.
read-only, inherited
frequency Duration?
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
measure Measure?
The Measure that configures this probe.
read-only, inherited
name String
A printer-friendly name for this probe.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
state ProbeState
The runtime state of this probe.
read-only, inherited
stateEvents Stream<ProbeState>
The runtime state changes of this probe. [...]
read-only, inherited
timer Timer?
read / write
type String
The type of this probe according to String.
read-only, inherited

Methods

error() → void
inherited
getDatum() Future<Datum?>
Subclasses should implement / override this method to collect the Datum. This method will be called every time data has been buffered for a duration and should return the final Datum for the buffered data. [...]
override
hasChanged(Measure measure) → void
Callback when this probe's measure has changed.
inherited
initialize(Measure measure) → void
Initialize the probe before starting it. [...]
inherited
mark() → void
Mark the latest sampling
@protected, inherited
marking() → void
Get the latest mark
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
onInitialize(Measure measure) → void
Callback for initialization of probe. [...]
override
onPause() Future
Callback for pausing probe
override
onRestart() Future
Callback for restarting probe
override
onResume() Future
Callback for resuming probe
override
onSamplingEnd() → void
Handler called when sampling period ends.
onSamplingStart() → void
Handler called when sampling period starts.
onStop() Future
Callback for stopping probe
override
pause() → void
Pause the probe. The probe is paused until resume or restart is called.
inherited
restart() → void
Restart the probe. [...]
inherited
resume() → void
Resume the probe.
inherited
stop() → void
Stop the probe. Once a probe is stopped, it cannot be started again. If you need to restart a probe, use the restart or pause and resume methods.
inherited
toString() String
A string representation of this object. [...]
inherited
validNextState(ProbeState nextState) bool
Is ProbeState a valid next state for this probe? [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited