Skip to content

Latest commit

 

History

History
208 lines (155 loc) · 5.65 KB

README.md

File metadata and controls

208 lines (155 loc) · 5.65 KB
Raw

Reachability.swift

Reachability.swift is a replacement for Apple's Reachability sample, re-written in Swift with closures.

It is compatible with iOS (8.0 - 10.0), OSX (10.9 - 10.12) and tvOS (9.0 - 10.0)

Inspired by https://github.com/tonymillion/Reachability

#IMPORTANT

##Supporting Swift 2.3 and Swift 3

The source has been updated to support both Swift 2.3 (tag v2.4) and Swift 3 (tag v3.0)

To install Reachability.swift for Swift 2.3 using CocoaPods, include the following in your Podfile

pod 'ReachabilitySwift', '~> 2.4'

To install Reachability.swift for Swift 3.x using CocoaPods, include the following in your Podfile

pod 'ReachabilitySwift', '~> 3'

##Swift 3 breaking changes#

Previously:

class func reachabilityForInternetConnection() throws

Now:

init?()

Previously:

init(hostname: String) throws

Now:

init?(hostname: String)

Previously:

public enum NetworkStatus: CustomStringConvertible {
    case NotReachable, ReachableViaWiFi, ReachableViaWWAN
}

Now:

public enum NetworkStatus: CustomStringConvertible {
    case notReachable, reachableViaWiFi, reachableViaWWAN
}

Got a problem?

Please read https://github.com/ashleymills/Reachability.swift/wiki/Raising-an-issue before raising an issue.

Supporting Reachability.swift

Keeping Reachability.swift up-to-date is a time consuming task. Making updates, reviewing pull requests, responding to issues and answering emails all take time. If you'd like to help keep me motivated, please download my free app, Foto Flipper from the App Store. (To really motivate me, pay $0.99 for the IAP!)

And don't forget to ★ the repo. This increases its visibility and encourages others to contribute.

Thanks Ash

Installation

Manual

Just drop the Reachability.swift file into your project. That's it!

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. To install Reachability.swift with CocoaPods:

  1. Make sure CocoaPods is installed.

  2. Update your Podfile to include the following:

    use_frameworks!
pod 'ReachabilitySwift'

  3. Run pod install.

  1. In your code import Reachability like so: import ReachabilitySwift

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To install Reachability.swift with Carthage:

  1. Install Carthage via Homebrew
$ brew update
$ brew install carthage

  1. Add github "ashleymills/Reachability.swift" to your Cartfile.

  2. Run carthage update.

  3. Drag Reachability.framework from the Carthage/Build/iOS/ directory to the Linked Frameworks and Libraries section of your Xcode project’s General settings.

  4. Add $(SRCROOT)/Carthage/Build/iOS/Reachability.framework to Input Files of Run Script Phase for Carthage.

Example - closures

//declare this property where it won't go out of scope relative to your listener
let reachability = Reachability()!

reachability.whenReachable = { reachability in
    // this is called on a background thread, but UI updates must
    // be on the main thread, like this:
    dispatch_async(dispatch_get_main_queue()) {
        if reachability.isReachableViaWiFi() {
            print("Reachable via WiFi")
        } else {
            print("Reachable via Cellular")
        }
    }
}
reachability.whenUnreachable = { reachability in
    // this is called on a background thread, but UI updates must
    // be on the main thread, like this:
    dispatch_async(dispatch_get_main_queue()) {
        print("Not reachable")
    }
}

do {
    try reachability.startNotifier()
} catch {
    print("Unable to start notifier")
}

and for stopping notifications

reachability.stopNotifier()

Example - notifications

This sample will use NSNotifications to notify when the interface has changed. They will be delivered on the MAIN THREAD, so you can do UI updates from within the function.

//declare this property where it won't go out of scope relative to your listener
let reachability = Reachability()!

//declare this inside of viewWillAppear

     NotificationCenter.default.addObserver(self, selector: #selector(self.reachabilityChanged),name: ReachabilityChangedNotification,object: reachability)
    do{
      try reachability.startNotifier()
    }catch{
      print("could not start reachability notifier")
    }

and

func reachabilityChanged(note: NSNotification) {

  let reachability = note.object as! Reachability

  if reachability.isReachable {
    if reachability.isReachableViaWiFi {
      print("Reachable via WiFi")
    } else {
      print("Reachable via Cellular")
    }
  } else {
    print("Network not reachable")
  }
}

and for stopping notifications

reachability.stopNotifier()
NSNotificationCenter.defaultCenter().removeObserver(self,
                                                    name: ReachabilityChangedNotification,
                                                    object: reachability)

Want to help?

Got a bug fix, or a new feature? Create a pull request and go for it!

Let me know!

If you use Reachability.swift, please let me know about your app and I'll put a link here… and tell your friends!

Cheers, Ash