NetworkService class

The internal engine that combines connectivity, Internet reachability, server health and network quality into a single NetworkInfo stream, applying debouncing, periodic re-checks, app lifecycle awareness and recovery callbacks.

You normally don't use this directly — NetworkGuard wraps it as a convenient singleton facade. It's exposed separately so it can be unit tested and so advanced users can run multiple independent instances if ever needed.

Mixed-in types

Constructors

NetworkService({required NetworkGuardConfig config, ConnectivityService? connectivityService, InternetChecker? internetChecker, NetworkLogger? logger})
Creates a NetworkService configured by config.

Properties

config → NetworkGuardConfig
The configuration this service was created with.
final
current → NetworkInfo
The most recent NetworkInfo snapshot.
no setter
hashCode → int
The hash code for this object.
no setterinherited
history → List<NetworkEvent>
A read-only view of recent NetworkEvents, oldest first, capped at NetworkGuardConfig.eventHistorySize.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverHealth → Map<String, ServerHealth>
The latest health snapshot for each configured server.
no setter
stream → Stream<NetworkInfo>
Emits a new NetworkInfo whenever a check produces a state that is meaningfully different from current (see NetworkInfo.==).
no setter

Methods

checkNow() → Future<NetworkInfo>
Runs a full check right now: connectivity type, real Internet reachability, and (if configured) server health — then updates current, appends to history and emits on stream if the resulting state differs from before.
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
override
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
dispose() → void
Stops monitoring and releases every underlying resource (streams, timers, HTTP clients).
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleStatusBarTap() → void
Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
start() → Future<void>
Starts monitoring: an immediate check, then a live subscription to connectivity changes plus periodic re-checks, honoring NetworkGuardConfig.enableMonitoring.
stop() → void
Stops all monitoring (timers, subscriptions, lifecycle observer) without disposing checkers, so start can be called again.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited