Skip to content

Commit

Permalink
Add GCD Support to ReachabilityMonitor (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
@vsanthanam
vsanthanam authored Jul 1, 2022
1 parent df622af commit 2054978
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 36 deletions.
2 changes: 1 addition & 1 deletion Sources/NetworkReachability/API/ReachabilityMonitor/ReachabilityMonitor+Combine.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
func request(_ demand: Subscribers.Demand) {
requested += 1
do {
networkMonitor = ReachabilityMonitor(try refBuilder()) { [weak self] result in
networkMonitor = .withContinuation(try refBuilder()) { [weak self] result in
guard let self = self,
let subscriber = self.subscriber,
self.requested > .none else { return }
Expand Down
2 changes: 1 addition & 1 deletion Sources/NetworkReachability/API/ReachabilityMonitor/ReachabilityMonitor+Concurrency.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public extension ReachabilityMonitor {
private func stream(_ refBuilder: () throws -> SCNetworkReachability) -> AsyncThrowingStream<Reachability, Swift.Error> {
.init(bufferingPolicy: .bufferingNewest(1)) { continuation in
do {
_ = ReachabilityMonitor(try refBuilder()) { result in
_ = ReachabilityMonitor.withContinuation(try refBuilder()) { result in
do {
let reachability = try result.get()
continuation.yield(reachability)
Expand Down
216 changes: 183 additions & 33 deletions Sources/NetworkReachability/API/ReachabilityMonitor/ReachabilityMonitor.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,25 @@ import SystemConfiguration
/// - ``init(host:)``
/// - ``init(address:)``
/// - ``init(updateHandler:)``
/// - ``init(updateQueue:updateHandler:)``
/// - ``init(host:updateHandler:)``
/// - ``init(host:updateQueue:updateHandler:)``
/// - ``init(address:updateHandler:)``
/// - ``init(address:updateQueue:updateHandler:)``
/// - ``init(delegate:)``
/// - ``init(updateQueue:delegate:)``
/// - ``init(host:delegate:)``
/// - ``init(host:updateQueue:delegate:)``
/// - ``init(address:delegate:)``
/// - ``init(address:updateQueue:delegate:)``
///
/// ### Delegation
///
/// - ``Delegate-swift.typealias``
/// - ``delegate-swift.property``
///
/// ### Closures
/// ### Closure Callbacks
///
/// - ``updateHandler-swift.property``
/// - ``UpdateHandler-swift.typealias``
/// - ``Result``
/// - ``Error``
/// - ``updateQueue``
///
/// ### Swift Concurrency
///
Expand All @@ -72,9 +74,16 @@ import SystemConfiguration
/// - ``reachabilityUpdates(forHost:)``
/// - ``reachabilityUpdates(forAddress:)``
///
/// ### Delegation
///
/// - ``Delegate-swift.typealias``
/// - ``delegate-swift.property``
/// - ``updateQueue``
///
/// ### Notifications
///
/// - ``reachabilityChangedNotificationName``
/// - ``updateQueue``
///
/// ### Combine
///
Expand Down Expand Up @@ -102,7 +111,8 @@ public final class ReachabilityMonitor {
public convenience init() throws {
self.init(ref: try .general,
updateHandler: nil,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachablity monitor for a specific host
Expand All @@ -115,7 +125,8 @@ public final class ReachabilityMonitor {
public convenience init(host: String) throws {
self.init(ref: try .forHost(host),
updateHandler: nil,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachablity monitor for a socket address
Expand All @@ -128,13 +139,12 @@ public final class ReachabilityMonitor {
public convenience init(address: sockaddr) throws {
self.init(ref: try .forAddress(address),
updateHandler: nil,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachability monitor with a closure used to respond to reachability changes
///
/// Use this initializer to respond to reachability updates with a closure
///
/// - Parameter updateHandler: The closure used to observe reachability updates
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
Expand All @@ -143,7 +153,25 @@ public final class ReachabilityMonitor {
public convenience init(updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .general,
updateHandler: updateHandler,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachability monitor with a closure used to respond to reachability changes on a specific queue
///
/// - Parameters:
/// - updateQueue: Dispatch queue used to invoke the update handler
/// - updateHandler: The closure used to observe reachability updates
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error
public convenience init(updateQueue: DispatchQueue,
updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .general,
updateHandler: updateHandler,
delegate: nil,
updateQueue: updateQueue)
}

/// Create a reachability monitor for a specific host with a closure used to respond to reachability changes
Expand All @@ -159,7 +187,27 @@ public final class ReachabilityMonitor {
updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .forHost(host),
updateHandler: updateHandler,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachability monitor for a specific host with a closure used to respond to reachability changes on a specific queue
///
/// - Parameters:
/// - host: The host to monitor
/// - updateQueue: Dispatch queue used to invoke the update handler
/// - updateHandler: The closure used to observe reachability updates
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(host: String,
updateQueue: DispatchQueue,
updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .forHost(host),
updateHandler: updateHandler,
delegate: nil,
updateQueue: updateQueue)
}

/// Create a reachability monitor for a specific socket address with a closure used to respond to reachability changes
Expand All @@ -175,12 +223,30 @@ public final class ReachabilityMonitor {
updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .forAddress(address),
updateHandler: updateHandler,
delegate: nil)
delegate: nil,
updateQueue: nil)
}

/// Create a reachability monitor with a delegate object used to respond to reachability changes
/// Create a reachability monitor for a specific socket address with a closure used to respond to reachability changes on a specific queue
///
/// - Parameters:
/// - address: The socket address to monitor
/// - updateQueue: Dispatch queue used to invoke the update handler
/// - updateHandler: The closure used to observe reachability updates
///
/// Use this initializer to respond to reachability updates with an instance of an object that conforms to ``ReachabilityMonitorDelegate``
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(address: sockaddr,
updateQueue: DispatchQueue,
updateHandler: @escaping UpdateHandler) throws {
self.init(ref: try .forAddress(address),
updateHandler: updateHandler,
delegate: nil,
updateQueue: updateQueue)
}

/// Create a reachability monitor with a delegate object used to respond to reachability changes
///
/// - Parameter delegate: The delegate object used to observe reachability updates
///
Expand All @@ -190,39 +256,97 @@ public final class ReachabilityMonitor {
public convenience init(delegate: any Delegate) throws {
self.init(ref: try .general,
updateHandler: nil,
delegate: delegate)
delegate: delegate,
updateQueue: nil)
}

/// Create a reachability monitor with a delegate object used to respond to reachability changes
///
/// - Parameters:
/// - updateQueue: Dispatch queue used to invoke the delegate callbacks
/// - delegate: The delegate object used to observe reachability updates
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(updateQueue: DispatchQueue,
delegate: any Delegate) throws {
self.init(ref: try .general,
updateHandler: nil,
delegate: delegate,
updateQueue: updateQueue)
}

/// Create a reachability monitor for a specific host with a delegate object used to respond to reachability changes
///
/// - Parameters:
/// - host: The host to monitor
/// - delegate: The delegate object used to observe reachability update
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(host: String,
delegate: any Delegate) throws {
self.init(ref: try .forHost(host),
updateHandler: nil,
delegate: delegate,
updateQueue: nil)
}

/// Create a reachability monitor for a specific host with a delegate object used to respond to reachability changes
///
/// - Parameters:
/// - host: The host to monitor
/// - updateQueue: Dispatch queue used to invoke the delegate callbacks
/// - delegate: The delegate object used to observe reachability update
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(host: String,
updateQueue: DispatchQueue,
delegate: any Delegate) throws {
self.init(ref: try .forHost(host),
updateHandler: nil,
delegate: delegate)
delegate: delegate,
updateQueue: updateQueue)
}

/// Create a reachability monitor for a specific socket address with a delegate object used to respond to reachability changes
///
/// - Parameters:
/// - address: The socket address to monitor
/// - delegate: The delegate object used to observe reachability update
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(address: sockaddr,
delegate: any Delegate) throws {
self.init(ref: try .forAddress(address),
updateHandler: nil,
delegate: delegate,
updateQueue: nil)
}

/// Create a reachability monitor for a specific socket address with a delegate object used to respond to reachability changes
///
/// - Parameters:
/// - address: The socket address to monitor
/// - updateQueue: Dispatch queue used to invoke the delegate callbacks
/// - delegate: The delegate object used to observe reachability update
///
/// - Note: A reachability monitor begins observing and publishing reachability updates immediately after initialization.
///
/// - Throws: An error of type ``Error``
public convenience init(address: sockaddr,
updateQueue: DispatchQueue,
delegate: any Delegate) throws {
self.init(ref: try .forAddress(address),
updateHandler: nil,
delegate: delegate)
delegate: delegate,
updateQueue: updateQueue)
}

// MARK: - API
Expand Down Expand Up @@ -256,16 +380,23 @@ public final class ReachabilityMonitor {
///
/// - Tip: The closure only recieves status changes that occured after it was assigned. To recieve every status update, including the reachability status at the time the monitor was initialized, pass in the closure on initialization of the monitor.
///
/// - Note: Instances of ``ReachabilityMonitor`` will always invoke this closure the main thread.
/// - Note: Instances of ``ReachabilityMonitor`` will always invoke this closure on the ``updateQueue``
public var updateHandler: UpdateHandler?

/// The delegate object used to observe reachability updates
///
/// See ``Delegate-swift.typealias`` for more information.
///
/// - Tip: The delegate only recieves status changes that occured after it was assigned. To recieve every status update, including the reachability status at the time the monitor was initialized, pass in the delegate on initialization of the monitor.
///
/// - Important: Instances of ``ReachabilityMonitor`` will perform delegate callbacks on the ``updateQueue``
public weak var delegate: (any Delegate)?

/// The dispatch queue used to send closure callbacks, delegate callbacks, and notifications.
///
/// Set this value to `nil` to use the main thread.
public var updateQueue: DispatchQueue?

/// The current reachability status
///
/// Use this property to retrieve the current reachability reachability in a synchronous context:
Expand Down Expand Up @@ -344,25 +475,28 @@ public final class ReachabilityMonitor {

// MARK: - Private

static func withContinuation(_ ref: SCNetworkReachability,
continuation: @escaping (Result) -> Void) -> ReachabilityMonitor {
ReachabilityMonitor(ref: ref,
updateHandler: nil,
delegate: nil,
continuation: continuation,
updateQueue: nil)
}

private init(ref: SCNetworkReachability,
updateHandler: UpdateHandler?,
delegate: (any Delegate)?,
continuation: ((Result) -> Void)? = nil) {
continuation: ((Result) -> Void)? = nil,
updateQueue: DispatchQueue?) {
self.ref = ref
self.updateHandler = updateHandler
self.delegate = delegate
self.continuation = continuation
self.updateQueue = updateQueue
setUp()
}

convenience init(_ ref: SCNetworkReachability,
continuation: @escaping (Result) -> Void) {
self.init(ref: ref,
updateHandler: nil,
delegate: nil,
continuation: continuation)
}

private var ref: SCNetworkReachability
private var continuation: ((Result) -> Void)?

Expand Down Expand Up @@ -433,8 +567,16 @@ public final class ReachabilityMonitor {

private func succeed(with flags: SCNetworkReachabilityFlags?) {
let reachability = Reachability(flags: flags)
continuation?(.success(reachability))
if #available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) {
if let continuation = continuation {
continuation(.success(reachability))
} else if let updateQueue = updateQueue {
updateQueue.async { [weak self] in
guard let self = self else { return }
self.postNotification()
self.updateDelegate(reachability: reachability)
self.updateHandler?(self, .success(reachability))
}
} else if #available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) {
Task {
await MainActor.run {
postNotification()
Expand All @@ -453,8 +595,16 @@ public final class ReachabilityMonitor {
}

private func fail(with error: Error) {
continuation?(.failure(error))
if #available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) {
if let continuation = continuation {
continuation(.failure(error))
} else if let updateQueue = updateQueue {
updateQueue.async { [weak self] in
guard let self = self else { return }
self.postNotification()
self.failDelegate(error)
self.updateHandler?(self, .failure(error))
}
} else if #available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) {
Task {
await MainActor.run {
postNotification()
Expand Down
Loading

0 comments on commit 2054978

Please sign in to comment.