PeriodicStreamProbe class Null safety

A periodic probe listening on a stream. Listening is done periodically as specified in a PeriodicMeasure listening on intervals every frequency for a period of duration. During this period, all data are forwarded to this probes data stream.

Just like in StreamProbe, sub-classes must implement the

Stream<DataPoint>? get stream => ...

method in order to provide the stream to collect data from.

Note that this probe will finish its collection period even if it is paused. Hence, data can still be generated from this probe, even if paused. Pausing will pause the creation of new collection periods.

Inheritance
Implementers

Constructors

PeriodicStreamProbe()

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
stream Stream<Datum>?
The stream of Datum objects for this StreamProbe. Must be implemented by sub-classes. Can return null if no stream of data is available.
read-only, inherited
subscription StreamSubscription?
read / write, inherited
timer Timer?
read / write
type String
The type of this probe according to String.
read-only, inherited

Methods

error() → void
inherited
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
onData(Datum datum) → void
inherited
onDone() → void
inherited
onError(dynamic error) → void
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
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