AtClientTelemetryService class

Telemetry Service for an AtProtocol client (i.e. emitter of atProtocol verb commands)

We'll set ourselves as the telemetry service in the supplied AtClient, SyncService, NotificationService, LocalSecondary, RemoteSecondary, SecondaryKeyStore, CommitLog, etc etc etc

Those classes will be instrumented to add AtTelemetryEvents to this service's stream.

Additionally, this class will 'know' how to ask various classes for point-in-time values such as the current size of the key store, how much data has been sent over the network, how much data has been received over the network, the number of keystore operations, the number of sync operations, the number of entries synced to the server, the number synced from the server, etc etc etc

Inheritance

• Object
• AtTelemetryService
• AtClientTelemetryService

Annotations

• @experimental

Constructors

AtClientTelemetryService(AtClient atClient, {StreamController<AtTelemetryEvent>? controller})

Properties

atClient → AtClient

final

controller → StreamController<AtTelemetryEvent>

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

samples → Iterator<AtTelemetrySample>

The AtTelemetrySamples which this telemetry service has taken

no setter, override

stream → Stream<AtTelemetryEvent>

A broadcast stream of AtTelemetryEvent

no setter, inherited

Methods

addSample(AtTelemetrySample sample) → void

Add a sample which has been taken

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

takeSample({String? sampleName}) → Future<void>

Request that sample(s) be taken. If sampleName is not supplied, samples will be taken for all known sample names.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited