data_connection_checker 0.3.4

data_connection_checker #

Pub

A pure Dart utility library that checks for an internet connection by opening a socket to a list of specified addresses, each with individual port and timeout. Defaults are provided for convenience.

Note that this plugin is in beta and may still have a few issues. Feedback is welcome.

Table of contents #

Description #

Checks for an internet (data) connection, by opening a socket to a list of addresses.

The defaults of the plugin should be sufficient to reliably determine if the device is currently connected to the global network, e.i. has access to the Internet.

Note that you should not be using the current network status for deciding whether you can reliably make a network connection. Always guard your app code against timeouts and errors that might come from the network layer.

Quick start #

DataConnectionChecker() is actually a Singleton. Calling DataConnectionChecker() is guaranteed to always return the same instance.

You can supply a new list to DataConnectionChecker().addresses if you need to check different destinations, ports and timeouts. Also, each address can have its own port and timeout. See InternetAddressCheckOptions in the docs for more info.

First you need to install it (this is the preferred way)

Then you can start using the library:

bool result = await DataConnectionChecker().hasConnection;
if(result == true) {
  print('YAY! Free cute dog pics!');
} else {
  print('No internet :( Reason:');
  print(DataConnectionChecker().lastTryResults);
}

Purpose #

The reason this package exists is that connectivity package cannot reliably determine if a data connection is actually available. More info on its page here: https://pub.dev/packages/connectivity

More info on the issue in general:

You can use this package in combination with connectivity in the following way:

var isDeviceConnected = false;

var subscription = Connectivity().onConnectivityChanged.listen((ConnectivityResult result) async {
  if(result != ConnectivityResult.none) {
    isDeviceConnected = await DataConnectionChecker().hasConnection;
  }
});

Note: remember to properly cancel the subscription when it's no longer needed. See connectivity package docs for more info.

How it works #

All addresses are pinged simultaneously. On successful result (socket connection to address/port succeeds) a true boolean is pushed to a list, on failure (usually on timeout, default 10 sec) a false boolean is pushed to the same list.

When all the requests complete with either success or failure, a check is made to see if the list contains at least one true boolean. If it does, then an external address is available, so we have data connection. If all the values in this list are false, then we have no connection to the outside world of cute cat and dog pictures, so hasConnection also returns false too.

This all happens at the same time for all addresses, so the maximum waiting time is the address with the highest specified timeout, in case it's unreachable.

I believe this is a reliable and fast method to check if a data connection is available to a device, but I may be wrong. I suggest you open an issue on the Github repository page if you have a better way of.

Defaults #

The defaults are based on data collected from https://perfops.net/, https://www.dnsperf.com/#!dns-resolvers

Here's some more info about the defaults:

DEFAULT_ADDRESSES #

... includes the top 3 globally available free DNS resolvers.

AddressProviderInfo
1.1.1.1CloudFlarehttps://1.1.1.1
1.0.0.1CloudFlarehttps://1.1.1.1
8.8.8.8Googlehttps://developers.google.com/speed/public-dns/
8.8.4.4Googlehttps://developers.google.com/speed/public-dns/
208.67.222.222OpenDNShttps://use.opendns.com/
208.67.220.220OpenDNShttps://use.opendns.com/
static final List<AddressCheckOptions> DEFAULT_ADDRESSES = List.unmodifiable([
  AddressCheckOptions(
    InternetAddress('1.1.1.1'),
    port: DEFAULT_PORT,
    timeout: DEFAULT_TIMEOUT,
  ),
  AddressCheckOptions(
    InternetAddress('8.8.4.4'),
    port: DEFAULT_PORT,
    timeout: DEFAULT_TIMEOUT,
  ),
  AddressCheckOptions(
    InternetAddress('208.67.222.222'),
    port: DEFAULT_PORT,
    timeout: DEFAULT_TIMEOUT,
  ),
]);

DEFAULT_PORT #

... is 53.

A DNS server listens for requests on port 53 (both UDP and TCP). So all DNS requests are sent to port 53 ...

More info:

static const int DEFAULT_PORT = 53;

DEFAULT_TIMEOUT #

... is 10 seconds.

static const Duration DEFAULT_TIMEOUT = Duration(seconds: 10);

DEFAULT_INTERVAL #

... is 10 seconds. Interval is the time between automatic checks. Automatic checks start if there's a listener attached to onStatusChange, thus remember to cancel unneeded subscriptions.

checkInterval (which controls how often a check is made) defaults to this value. You can change it if you need to perform checks more often or otherwise.

static const Duration DEFAULT_INTERVAL = const Duration(seconds: 10);
...
Duration checkInterval = DEFAULT_INTERVAL;

Usage #

Example:

import 'package:data_connection_checker/data_connection_checker.dart';

main() async {
  // Simple check to see if we have internet
  print("The statement 'this machine is connected to the Internet' is: ");
  print(await DataConnectionChecker().hasConnection);
  // returns a bool

  // We can also get an enum value instead of a bool
  print("Current status: ${await DataConnectionChecker().connectionStatus}");
  // prints either DataConnectionStatus.connected
  // or DataConnectionStatus.disconnected

  // This returns the last results from the last call
  // to either hasConnection or connectionStatus
  print("Last results: ${DataConnectionChecker().lastTryResults}");

  // actively listen for status updates
  // this will cause DataConnectionChecker to check periodically
  // with the interval specified in DataConnectionChecker().checkInterval
  // until listener.cancel() is called
  var listener = DataConnectionChecker().onStatusChange.listen((status) {
    switch (status) {
      case DataConnectionStatus.connected:
        print('Data connection is available.');
        break;
      case DataConnectionStatus.disconnected:
        print('You are disconnected from the internet.');
        break;
    }
  });

  // close listener after 30 seconds, so the program doesn't run forever
  await Future.delayed(Duration(seconds: 30));
  await listener.cancel();
}

Note: Remember to dispose of any listeners, when they're not needed to prevent memory leaks, e.g. in a StatefulWidget's dispose() method:

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

See example folder for more examples.

License #

MIT

Copyright 2019 Kristiyan Mitev and Spirit Navigator

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Features and bugs #

Please file feature requests and bugs at the issue tracker.

0.3.3 (and 0.3.4) #

  • Bumping version number, so pub.dev can accept the package
  • Add more docs for onStatusChange

0.3.2 #

  • Fix status not updated bug (_lastStatus being set incorrectly)

0.3.1 #

  • Fix annoying dartfmt warning (perfectionism intensifies)

0.3.0 #

  • Added onStatusChange stream, which users of this lib can subscribe to and listen for status changes. Emit values of DataConnectionStatus
  • Added checkInterval which controls how often a check is made when someone is listening to onStatusChange. Defaults to DEFAULT_INTERVAL (10 seconds)

0.2.1 #

Breaking change

  • hasDataConnection is now called hasConnection

Non breaking

  • isHostReachable() is now public. It allows for individual checks.
  • Fix DEFAULT_ADDRESSES to be unmodifiable
  • removed getter lastTryLog
  • added getter connectionStatus
  • added getter lastTryResults
  • updated example and readme

0.2.0 #

  • Breaking changes
  • This utility is now a Singleton (DataConnectionChecker() always returns the same instance) as it doesn't make sense to have more than one instance of this class
  • addresses is a List<InternetAddressCheckOptions> now. See the docs for more info
  • Each address can now have its own port and timeout assigned.

0.1.3 #

  • Add more info in the README

0.1.2 #

  • Minor refactoring
  • Update README with more info

0.1.1 #

  • Remove pedantic as a dependency

0.1.0 #

  • Initial version

example/example.dart

import 'package:data_connection_checker/data_connection_checker.dart';

main() async {
  // Simple check to see if we have internet
  print("The statement 'this machine is connected to the Internet' is: ");
  print(await DataConnectionChecker().hasConnection);
  // returns a bool

  // We can also get an enum instead of a bool
  print("Current status: ${await DataConnectionChecker().connectionStatus}");
  // prints either DataConnectionStatus.connected
  // or DataConnectionStatus.disconnected

  // This returns the last results from the last call
  // to either hasConnection or connectionStatus
  print("Last results: ${DataConnectionChecker().lastTryResults}");

  // actively listen for status updates
  var listener = DataConnectionChecker().onStatusChange.listen((status) {
    switch (status) {
      case DataConnectionStatus.connected:
        print('Data connection is available.');
        break;
      case DataConnectionStatus.disconnected:
        print('You are disconnected from the internet.');
        break;
    }
  });

  // close listener after 30 seconds, so the program doesn't run forever
  await Future.delayed(Duration(seconds: 30));
  await listener.cancel();
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  data_connection_checker: ^0.3.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:data_connection_checker/data_connection_checker.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
86
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
93
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, other

Primary library: package:data_connection_checker/data_connection_checker.dart with components: io.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
Dev dependencies
pedantic ^1.7.0
test ^1.0.0