https://github.com/vsanthanam/networkreachability

Modern Network Reachability in Swift using Structured Concurrency
https://github.com/vsanthanam/networkreachability

async await combine ios macos reachability spm structured-concurrency swift tvos watchos xcode

Last synced: 5 months ago
JSON representation

Modern Network Reachability in Swift using Structured Concurrency

• Host: GitHub
• URL: https://github.com/vsanthanam/networkreachability
• Owner: vsanthanam
• License: mit
• Created: 2022-05-14T20:47:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-30T11:31:37.000Z (6 months ago)
• Last Synced: 2025-05-10T04:01:55.613Z (5 months ago)
• Topics: async, await, combine, ios, macos, reachability, spm, structured-concurrency, swift, tvos, watchos, xcode
• Language: Swift
• Homepage: https://reachability.tools
• Size: 19.7 MB
• Stars: 22
• Watchers: 1
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# NetworkReachability



    

    


    


    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



NetworkReachability is a replacement for Apple's [SystemConfiguration](https://developer.apple.com/documentation/systemconfiguration) [Network Reachability APIs](https://developer.apple.com/documentation/systemconfiguration/scnetworkreachability?language=swift). Because these APIs were originally written in C, they are quite old and cumbersome to use from Swift. In 2018, Apple added the [Network](https://developer.apple.com/documentation/network) framework which introduced the [`NWPathMonitor`](https://developer.apple.com/documentation/network/nwpathmonitor) class. This API addressed some of the problems with [`SCNetworkReachability`](https://developer.apple.com/documentation/systemconfiguration/scnetworkreachability?language=swift), but was still cumbersome to integrate into many commonly used app patterns. NetworkReachability wraps both these APIs in easy to use Swift wrappers with similar interfaces and features that will be familiar to most iOS developers. Using NetworkReachablity, you can easily integrate reachability observation into your app's pipeline using just a few lines of code.

NetworkReachability supports synchronous reachability queries, as well as constant asynchronous reachability observation via the following mechanisms:

* [Delegation](https://developer.apple.com/library/archive/documentation/General/Conceptual/DevPedia-CocoaCore/Delegation.html)

* [Closures](https://docs.swift.org/swift-book/LanguageGuide/Closures.html)

* [NotificationCenter](https://developer.apple.com/documentation/foundation/notificationcenter)

* [Swift Concurrency](https://docs.swift.org/swift-book/LanguageGuide/Concurrency.html)

* [Combine](https://developer.apple.com/documentation/combine)

NetworkReachability supports [RxSwift](https://github.com/ReactiveX/RxSwift) bindings with an optional additional package: [NetworkReachabilityRxSwift](https://github.com/vsanthanam/NetworkReachabilityRxSwift). This optional package exists so that you can safely depend on NetworkReachability without also depending on RxSwift if you don't need to. **NetworkReachability itself has no non-apple dependencies.**

## Installation

NetworkReachability is currently distributed exclusively through the [Swift Package Manager](https://www.swift.org/package-manager/). 

To add NetworkReachability as a dependency to an existing Swift package, add the following line of code to the `dependencies` parameter of your `Package.swift` file:

```swift

dependencies: [

    .package(url: "https://github.com/vsanthanam/NetworkReachability.git", from: "1.0.0")

]

```

To add NetworkReachability as a dependency to an Xcode Project: 

- Choose `File` → `Add Packages...`

- Enter package URL `https://github.com/vsanthanam/NetworkReachability.git` and select your release of choice.

Other distribution mechanisms like CocoaPods or Carthage may be added in the future.

## Usage & Documentation

NetworkReachability's documentation is built with [DocC](https://developer.apple.com/documentation/docc) and included in the repository as a DocC archive. The latest version is hosted on [GitHub Pages](https://pages.github.com) and is available [here](https://reachability.tools/docs/documentation/networkreachability).

[![Documentation](Images/Documentation.svg)](https://reachability.tools/docs/documentation/networkreachability)

Additional installation instructions are available on the [Swift Package Index](https://swiftpackageindex.com/vsanthanam/NetworkReachability)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FNetworkReachability%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/vsanthanam/NetworkReachability)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FNetworkReachability%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/vsanthanam/NetworkReachability)

## License

**NetworkReachability** is available under the MIT license. See the LICENSE file for more information.