network_analyzer_platform_interface library
The platform contract and shared types for the network_analyzer federated plugin.
Platform implementations extend NetworkAnalyzerPlatform; host
applications never depend on this package directly — they use the
app-facing network_analyzer package, which re-exports the public
types defined here.
Classes
- ConnectionMetrics
- One snapshot of connection quality.
- CustomHost
- A monitoring target defined by the host application.
- EventUpdate
- An event occurred.
- GatewayInterface
- Monitors the local network's default gateway.
- HealthThresholds
- The cutoffs that turn measurements into a health verdict.
- InternetInterface
- Monitors the public internet through a chosen target.
- MetricsUpdate
- A measurement arrived.
- MonitorEvent
- One notable moment in a monitoring session.
- MonitorHost
- Where an internet monitor sends its probes.
- MonitorInterface
- A description of what to monitor, built by the host application.
- MonitorOptions
- Tuning for how often a session probes and how much history it weighs.
- MonitorSignal
- Something a platform implementation observed.
- MonitorUpdate
- Anything new from a monitoring session.
- NetworkAnalyzerPlatform
-
The interface that platform implementations of
network_analyzermust extend. - NetworkStateChange
- A change in the device's network situation, observed mid-session.
- ProbeSample
- The result of one probe.
-
Result<
T, S extends Failure> - Represents an operation that may either succeed or fail.
- SessionData
- The facts about a running monitoring session.
-
Success<
T> -
A generic success carrying a value of type
T. - VoidSuccess
- Specialization for operations that return nothing.
Enums
- ConnectionHealth
- An overall verdict on connection quality.
- MonitorEventKind
- What a MonitorEvent describes.
- MonitorKind
- What a monitoring session is watching.
- MonitorProtocol
- How monitoring probes are sent to a target.
- NetworkInterfaceType
- The kind of network interface a session is running over.
- PresetHost
- The public resolvers bundled with the plugin.
- ProbeOutcome
- How a single probe ended.
Typedefs
-
ResultCallback<
T, R> = T Function(R result) - A callback function that takes a result and returns a value.
Exceptions / Errors
- Failure
- Higher-order abstraction for failures. Implementers must expose a brief message and, optionally, longer details.
- GatewayDiscoveryFailure
- Raised when the current network exposes no default route to discover.
- InvalidConfigurationFailure
- Raised when a monitor configuration reaching the platform is invalid.
- NoActiveSessionFailure
- Raised when session facts are requested and no session is running.
- NotFailureException
- Thrown when Result.failure is accessed on a successful result.
- NotSuccessException
- Thrown when Result.success is accessed on a failed result.
- PermissionFailure
- Raised when an operating system permission the plugin needs is denied.
- ProbeTimeoutFailure
- Raised when an operation exceeds its documented timeout.
- SessionAlreadyRunningFailure
- Raised when monitoring is started while a session is already running.
- TargetUnreachableFailure
- Raised when the monitoring target cannot be reached at all.
- UnsupportedCapabilityFailure
- Raised when the platform cannot honor a requested capability.