connectivity_state_plus 0.1.8

Flutter connectivity plugin for WiFi, cellular, and restricted networks with real TCP reachability checks, custom ports, and cached probes.

connectivity_state_plus

connectivity_state_plus monitors WiFi, cellular, and restricted network states across Flutter platforms. In addition to detecting the active network interface, it can verify real TCP reachability to a configured host and port, avoiding false positives when a device is connected to WiFi or cellular but the required service cannot be reached.

Platform Support

Android	iOS	MacOS	Web	Linux	Windows
✅	✅	✅	✅	✅	✅

Requirements

• Flutter >=3.19.0
• Dart >=3.3.0 <4.0.0
• iOS >=12.0
• MacOS >=10.14
• Android compileSDK 34
• Java 17
• Android Gradle Plugin >=8.3.0
• Gradle wrapper >=8.4

Getting started

published on pub.dev, run this Flutter command

flutter pub add connectivity_state_plus

Real TCP Reachability

Configure the singleton Connectivity instance with the address your application needs to reach. The plugin parses the host and port, then attempts a real TCP connection. When WiFi or cellular is available but the configured service cannot be reached, it returns ConnectivityState.restricted.

Explicit ports are supported:

Connectivity().setAddressCheckOption('http://192.168.54.37:8080');

When no port is specified, HTTP uses port 80 and HTTPS uses port 443:

Connectivity().setAddressCheckOption('https://pub.dev');

Probe results are cached for 5 seconds, and concurrent checks share the same in-progress probe. This reduces socket creation when a host application calls checkConnectivity() frequently. Changing the configured address invalidates the cache immediately.

This is a TCP reachability check, not an HTTP health check. A successful TCP handshake is considered reachable regardless of the HTTP response status. Use an application-level HTTP request when response content or status codes must also be validated.

Usage

Sample usage to listen for active connectivity state changes by subscribing to the stream.

import 'package:connectivity_state_plus/connectivity_state_plus.dart';

@override
initState() {
  super.initState();

  StreamSubscription<ConnectivityState> subscription = Connectivity().onConnectivityChanged.listen((ConnectivityState result) {
    // Received changes in available connectivity state!
  });
}

// Be sure to cancel subscription
@override
dispose() {
  subscription.cancel();
  super.dispose();
}

Sample usage to check currently available connection state:

import 'package:connectivity_state_plus/connectivity_state_plus.dart';

final ConnectivityState connectivityState = await (Connectivity().checkConnectivity());

Sample usage for detecting whether the current network connection uses a VPN: [Note]: Only worked on iOS and macOS, otherwise would return ConnectivityState.other or ConnectivityState.unknown

import 'package:connectivity_state_plus/connectivity_state_plus.dart';

final ConnectivityState connectivityState = await (Connectivity().checkVPNConnectivity());

Platform Support

The following table shows which ConnectivityState values are supported per platform.

	Android	iOS	Web	MacOS	Windows	Linux
restricted	✅	✅	✅	✅	✅	✅
wifi	✅	✅	✅	✅	✅	✅
mobile	✅	✅		✅
vpn	✅				✅	✅
other	✅	✅		✅	✅	✅

none and unknown are supported on all platforms by default.

Android

Connectivity changes are no longer communicated to Android apps in the background starting with Android O (8.0). You should always check for connectivity status when your app is resumed. The broadcast is only useful when your application is in the foreground.

iOS & MacOS

On iOS simulators, the connectivity types stream might not update when Wi-Fi status changes. This is a known issue.

Starting with iOS 12 and MacOS 10.14, the implementation uses NWPathMonitor to obtain the enabled connectivity types. We noticed that this observer can give multiple or unreliable results. For example, reporting connectivity "none" followed by connectivity "wifi" right after reconnecting.

We recommend to use the onConnectivityChanged with this limitation in mind, as the method doesn't filter events, nor it ensures distinct values.

Web

In order to retrieve information about the quality/speed of a browser's connection, the web implementation of the connectivity plugin uses the browser's NetworkInformation Web API, which as of this writing (June 2020) is still "experimental", and not available in all browsers:

On desktop browsers, this API only returns a very broad set of connectivity statuses (One of 'slow-2g', '2g', '3g', or '4g'), and may not provide a Stream of changes. Firefox still hasn't enabled this feature by default.

Learn more

• API Documentation