Internet Connection Checker Plus

A Flutter package to check your internet connection with subsecond response times, even on mobile networks!

This library provides functionality to monitor and verify internet connectivity by checking reachability to various Uris. It relies on the connectivity_plus package for listening to connectivity changes and the http package for making network requests.

Features

• Check internet connectivity status
• Listen for internet connectivity changes

Supported Platforms

Permissions

Android

Add the following permissions to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET" />

macOS

Add the following permissions to your macOS .entitlements files:

<key>com.apple.security.network.client</key>
<true/>

For more information, see the Flutter Networking Documentation.

Usage

1. Add dependency

Add the internet_connection_checker_plus package to your pubspec.yaml file:

dependencies:
  internet_connection_checker_plus: ^2.5.2

2. Import the package

Import the internet_connection_checker_plus package into your Dart file:

import 'package:internet_connection_checker_plus/internet_connection_checker_plus.dart';

3. Checking for internet connectivity

The simplest way to check for internet connectivity is to use the InternetConnection class:

bool result = await InternetConnection().hasInternetAccess;

4. Listening for internet connectivity changes

The InternetConnection class also provides a stream of InternetStatus that can be used to listen for changes in internet connectivity:

final listener = InternetConnection().onStatusChange.listen((InternetStatus status) {
  switch (status) {
    case InternetStatus.connected:
      // The internet is now connected
      break;
    case InternetStatus.disconnected:
      // The internet is now disconnected
      break;
  }
});

Don't forget to cancel the subscription when it is no longer needed. This will prevent memory leaks and free up resources:

listener.cancel();

5. Add custom Uris to check

The InternetConnection class can be configured to check custom Uris for internet connectivity:

final connection = InternetConnection.createInstance(
  customCheckOptions: [
    InternetCheckOption(uri: Uri.parse('https://example.com')),
  ],
);

[!IMPORTANT]

Make sure the custom Uris have no caching enabled. Otherwise, the results may be inaccurate.

[!IMPORTANT]

On web platform, make sure the custom Uris are not CORS blocked. Otherwise, the results may be inaccurate.

6. Add custom success criteria

The InternetConnection class can be configured to check custom Uris for internet connectivity using custom success criteria:

final connection = InternetConnection.createInstance(
  customCheckOptions: [
    InternetCheckOption(
      uri: Uri.parse('https://example.com'),
      responseStatusFn: (response) {
        return response.statusCode >= 69 && response.statusCode < 169;
      },
    ),
    InternetCheckOption(
      uri: Uri.parse('https://example2.com'),
      responseStatusFn: (response) {
        return response.statusCode >= 420 && response.statusCode < 1412;
      },
    ),
  ],
);

7. Pause and Resume on App Lifecycle Changes

For situation where you want to pause any network requests when the app goes into the background and resume them when the app comes back into the foreground (see issue #27):

class MyWidget extends StatefulWidget {
  const MyWidget({super.key});

  @override
  State<MyWidget> createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> {
  late final StreamSubscription<InternetStatus> _subscription;
  late final AppLifecycleListener _listener;

  @override
  void initState() {
    super.initState();
    _subscription = InternetConnection().onStatusChange.listen((status) {
      // Handle internet status changes
    });
    _listener = AppLifecycleListener(
      onResume: _subscription.resume,
      onHide: _subscription.pause,
      onPause: _subscription.pause,
    );
  }

  @override
  void dispose() {
    _subscription.cancel();
    _listener.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    // Build your widget
  }
}

Default Uris

The InternetConnection class uses the following Uris by default:

Some Tested URIs

If you liked the package, then please give it a Like 👍🏼 and Star ⭐

Credits

This package is a cloned and modified version of the internet_connection_checker package which is a cloned and modified version of the data_connection_checker package which is no longer maintained.

The aim of this package is to support the web platform which is currently not supported by the internet_connection_checker package.