Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashleymills/Reachability.swift
Replacement for Apple's Reachability re-written in Swift with closures
https://github.com/ashleymills/Reachability.swift
Last synced: 3 months ago
JSON representation
Replacement for Apple's Reachability re-written in Swift with closures
- Host: GitHub
- URL: https://github.com/ashleymills/Reachability.swift
- Owner: ashleymills
- License: mit
- Created: 2014-09-21T14:32:36.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T15:08:20.000Z (6 months ago)
- Last Synced: 2024-05-18T13:01:24.652Z (6 months ago)
- Language: Swift
- Homepage:
- Size: 356 KB
- Stars: 7,898
- Watchers: 119
- Forks: 943
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ios - Reachability.swift - Replacement for Apple's Reachability re-written in Swift with closures. (Networking / Video)
- awesome-swift - Reachability.swift - A replacement for Apple's Reachability with closures. (Libs / Network)
- awesome-swift - Reachability.swift - A replacement for Apple's Reachability with closures. (Libs / Network)
- awesome-macos-libraries - Reachability - Replacement for Apple's Reachability re-written in Swift with closures. Language: Swift. (Network)
- awesome-swift - ReachabilitySwift - Network reachability library. (Networking)
- awesome-ios-star - Reachability.swift - Replacement for Apple's Reachability re-written in Swift with closures. (Networking / Video)
- fucking-awesome-swift - Reachability.swift - A replacement for Apple's Reachability with closures. (Libs / Network)
- awesome-swift-cn - Reachability.swift - A replacement for Apple's Reachability re-written in Swift with closures. (Libs / Network)
- awesome-swift - Reachability.swift - Replacement for Apple's Reachability re-written in Swift with closures ` 📝 8 months ago ` (Network [🔝](#readme))
README
# 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 - 12.0), **OSX** (10.9 - 10.14) and **tvOS** (9.0 - 12.0)
Inspired by https://github.com/tonymillion/Reachability
## 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.
Please consider sponsoring me https://github.com/sponsors/ashleymills, it's a great way to say thanks!
If you're an iOS developer who's looking for a quick and easy way to create App Store screenshots, please try out my app [Screenshot Producer](https://itunes.apple.com/app/apple-store/id1252374855?pt=215893&ct=reachability&mt=8)…
Devices | Layout | Copy | Localize | Export
:------:|:------:|:------:|:------:|:------:
 |  |  |  | 
And don't forget to **★** the repo. This increases its visibility and encourages others to contribute.
Thanks
Ash
## Got a problem?
Please read https://github.com/ashleymills/Reachability.swift/blob/master/CONTRIBUTING.md before raising an issue.
## 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][CocoaPods Installation].
2. Update your Podfile to include the following:
``` ruby
use_frameworks!
pod 'ReachabilitySwift'
```
3. Run `pod install`.
[CocoaPods]: https://cocoapods.org
[CocoaPods Installation]: https://guides.cocoapods.org/using/getting-started.html#getting-started
4. In your code import Reachability like so:
`import Reachability`
### 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][]
```bash
$ brew update
$ brew install carthage
```
2. Add `github "ashleymills/Reachability.swift"` to your Cartfile.
3. Run `carthage update`.
4. Drag `Reachability.framework` from the `Carthage/Build/iOS/` directory to the `Linked Frameworks and Libraries` section of your Xcode project’s `General` settings.
5. Add `$(SRCROOT)/Carthage/Build/iOS/Reachability.framework` to `Input Files` of Run Script Phase for Carthage.
6. In your code import Reachability like so:
`import Reachability`
[Carthage]: https://github.com/Carthage/Carthage
[Homebrew]: http://brew.sh
[Photo Flipper]: https://itunes.apple.com/app/apple-store/id749627884?pt=215893&ct=GitHubReachability&mt=8
### Swift Package Manager (SPM)
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. To integrate using Apple's Swift package manager from xcode :
1. File -> Swift Packages -> Add Package Dependency...
2. Enter package URL : https://github.com/ashleymills/Reachability.swift, choose the latest release
## Example - closures
NOTE: All closures are run on the **main queue**.
```swift
//declare this property where it won't go out of scope relative to your listener
let reachability = try! Reachability()
reachability.whenReachable = { reachability in
if reachability.connection == .wifi {
print("Reachable via WiFi")
} else {
print("Reachable via Cellular")
}
}
reachability.whenUnreachable = { _ in
print("Not reachable")
}
do {
try reachability.startNotifier()
} catch {
print("Unable to start notifier")
}
```
and for stopping notifications
```swift
reachability.stopNotifier()
```
## Example - notifications
NOTE: All notifications are delivered on the **main queue**.
```swift
//declare this property where it won't go out of scope relative to your listener
let reachability = try! Reachability()
//declare this inside of viewWillAppear
NotificationCenter.default.addObserver(self, selector: #selector(reachabilityChanged(note:)), name: .reachabilityChanged, object: reachability)
do{
try reachability.startNotifier()
}catch{
print("could not start reachability notifier")
}
```
and
```swift
@objc func reachabilityChanged(note: Notification) {
let reachability = note.object as! Reachability
switch reachability.connection {
case .wifi:
print("Reachable via WiFi")
case .cellular:
print("Reachable via Cellular")
case .unavailable:
print("Network not reachable")
}
}
```
and for stopping notifications
```swift
reachability.stopNotifier()
NotificationCenter.default.removeObserver(self, name: .reachabilityChanged, 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…](https://github.com/ashleymills/Reachability.swift/wiki/Apps-using-Reachability.swift) and tell your friends!
Cheers,
Ash