Updated Concurrency support for PeripheralManager

colemancda · colemancda · commit 0dd524f62fe1 · 2022-10-02T13:16:07.000-07:00
diff --git a/Sources/DarwinGATT/DarwinPeripheral.swift b/Sources/DarwinGATT/DarwinPeripheral.swift
@@ -35,11 +35,11 @@ public final class DarwinPeripheral: PeripheralManager {
         }
     }
     
-    public var willRead: ((GATTReadRequest<Central>) -> ATTError?)?
+    public var willRead: ((GATTReadRequest<Central>) async -> ATTError?)?
     
-    public var willWrite: ((GATTWriteRequest<Central>) -> ATTError?)?
+    public var willWrite: ((GATTWriteRequest<Central>) async -> ATTError?)?
     
-    public var didWrite: ((GATTWriteConfirmation<Central>) -> ())?
+    public var didWrite: ((GATTWriteConfirmation<Central>) async -> ())?
     
     private var database = Database()
     
@@ -402,64 +402,75 @@ internal extension DarwinPeripheral {
                 return
             }
             
-            if let error = self.peripheral.willRead?(readRequest) {
-                peripheralManager.respond(to: request, withResult: CBATTError.Code(rawValue: Int(error.rawValue))!)
-                return
+            Task {
+                if let error = await self.peripheral.willRead?(readRequest) {
+                    peripheral.queue.async {
+                        peripheralManager.respond(to: request, withResult: CBATTError.Code(rawValue: Int(error.rawValue))!)
+                    }
+                    return
+                }
+                peripheral.queue.async {
+                    let requestedValue = request.offset == 0 ? value : Data(value.suffix(request.offset))
+                    request.value = requestedValue
+                    peripheralManager.respond(to: request, withResult: .success)
+                }
             }
-            
-            let requestedValue = request.offset == 0 ? value : Data(value.suffix(request.offset))
-            request.value = requestedValue
-            peripheralManager.respond(to: request, withResult: .success)
         }
         
         @objc(peripheralManager:didReceiveWriteRequests:)
         public func peripheralManager(_ peripheralManager: CBPeripheralManager, didReceiveWrite requests: [CBATTRequest]) {
             
             log("Did receive write requests for \(requests.map { $0.characteristic.uuid })")
             assert(requests.isEmpty == false)
-            var writeRequests = [GATTWriteRequest<Central>]()
-            writeRequests.reserveCapacity(requests.count)
-            
-            // validate write requests
-            for request in requests {
-                let peer = Central(request.central)
-                let characteristic = self.peripheral.database[characteristic: request.characteristic]
-                let value = characteristic.value
-                let uuid = BluetoothUUID(request.characteristic.uuid)
-                let newValue = request.value ?? Data()
-                let writeRequest = GATTWriteRequest(
-                    central: peer,
-                    maximumUpdateValueLength: request.central.maximumUpdateValueLength,
-                    uuid: uuid,
-                    handle: characteristic.handle,
-                    value: value,
-                    newValue: newValue
-                )
-                // check if write is possible
-                if let error = self.peripheral.willWrite?(writeRequest) {
-                    peripheralManager.respond(to: requests[0], withResult: CBATTError.Code(rawValue: Int(error.rawValue))!)
-                    return
-                }
-                // compute new data
-                writeRequests.append(writeRequest)
-            }
             
-            // write new values
-            for request in writeRequests {
-                // update GATT DB
-                self.peripheral.database[characteristic: request.handle] = request.newValue
-                let confirmation = GATTWriteConfirmation(
-                    central: request.central,
-                    maximumUpdateValueLength: request.maximumUpdateValueLength,
-                    uuid: request.uuid,
-                    handle: request.handle,
-                    value: request.newValue
-                )
-                // did write callback
-                self.peripheral.didWrite?(confirmation)
+            Task {
+                var writeRequests = [GATTWriteRequest<Central>]()
+                writeRequests.reserveCapacity(requests.count)
+                // validate write requests
+                for request in requests {
+                    let peer = Central(request.central)
+                    let characteristic = self.peripheral.database[characteristic: request.characteristic]
+                    let value = characteristic.value
+                    let uuid = BluetoothUUID(request.characteristic.uuid)
+                    let newValue = request.value ?? Data()
+                    let writeRequest = GATTWriteRequest(
+                        central: peer,
+                        maximumUpdateValueLength: request.central.maximumUpdateValueLength,
+                        uuid: uuid,
+                        handle: characteristic.handle,
+                        value: value,
+                        newValue: newValue
+                    )
+                    // check if write is possible
+                    if let error = await self.peripheral.willWrite?(writeRequest) {
+                        peripheral.queue.async {
+                            peripheralManager.respond(to: requests[0], withResult: CBATTError.Code(rawValue: Int(error.rawValue))!)
+                        }
+                        return
+                    }
+                    // compute new data
+                    writeRequests.append(writeRequest)
+                }
+                
+                // write new values
+                for request in writeRequests {
+                    // update GATT DB
+                    self.peripheral.database[characteristic: request.handle] = request.newValue
+                    let confirmation = GATTWriteConfirmation(
+                        central: request.central,
+                        maximumUpdateValueLength: request.maximumUpdateValueLength,
+                        uuid: request.uuid,
+                        handle: request.handle,
+                        value: request.newValue
+                    )
+                    // did write callback
+                    await self.peripheral.didWrite?(confirmation)
+                }
+                
+                peripheral.queue.async {
+                    peripheralManager.respond(to: requests[0], withResult: .success)
+                }
             }
-            
-            peripheralManager.respond(to: requests[0], withResult: .success)
         }
         
         @objc(peripheralManager:central:didSubscribeToCharacteristic:)
diff --git a/Sources/GATT/GATTPeripheral.swift b/Sources/GATT/GATTPeripheral.swift
@@ -29,11 +29,11 @@ public final class GATTPeripheral <HostController: BluetoothHostControllerInterf
     
     public let options: Options
     
-    public var willRead: ((GATTReadRequest<Central>) -> ATTError?)?
+    public var willRead: ((GATTReadRequest<Central>) async -> ATTError?)?
     
-    public var willWrite: ((GATTWriteRequest<Central>) -> ATTError?)?
+    public var willWrite: ((GATTWriteRequest<Central>) async -> ATTError?)?
     
-    public var didWrite: ((GATTWriteConfirmation<Central>) -> ())?
+    public var didWrite: ((GATTWriteConfirmation<Central>) async -> ())?
     
     public var activeConnections: Set<Central> {
         get async {
@@ -175,19 +175,19 @@ extension GATTPeripheral: GATTServerConnectionDelegate {
         log?("[\(central)]: " + "Did disconnect. \(error?.localizedDescription ?? "")")
     }
     
-    func connection(_ central: Central, willRead request: GATTReadRequest<Central>) -> ATTError? {
-        return willRead?(request)
+    func connection(_ central: Central, willRead request: GATTReadRequest<Central>) async -> ATTError? {
+        return await willRead?(request)
     }
     
-    func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) -> ATTError? {
-        return willWrite?(request)
+    func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) async -> ATTError? {
+        return await willWrite?(request)
     }
     
     func connection(_ central: Central, didWrite confirmation: GATTWriteConfirmation<Central>) async {
         // update DB and inform other connections
         await write(confirmation.value, forCharacteristic: confirmation.handle, ignore: confirmation.central)
         // notify delegate
-        didWrite?(confirmation)
+        await didWrite?(confirmation)
     }
 }
 
diff --git a/Sources/GATT/GATTServerConnection.swift b/Sources/GATT/GATTServerConnection.swift
@@ -88,7 +88,7 @@ internal final class GATTServerConnection <Socket: L2CAPSocket> {
             value: value,
             offset: offset
         )
-        return delegate?.connection(central, willRead: request)
+        return await delegate?.connection(central, willRead: request)
     }
     
     private func willWrite(uuid: BluetoothUUID, handle: UInt16, value: Data, newValue: Data) async -> ATTError? {
@@ -100,7 +100,7 @@ internal final class GATTServerConnection <Socket: L2CAPSocket> {
             value: value,
             newValue: newValue
         )
-        return delegate?.connection(central, willWrite: request)
+        return await delegate?.connection(central, willWrite: request)
     }
     
     private func didWrite(uuid: BluetoothUUID, handle: UInt16, value: Data) async {
@@ -121,9 +121,9 @@ internal protocol GATTServerConnectionDelegate: AnyObject {
     
     func connection(_ central: Central, didDisconnect error: Error?) async
     
-    func connection(_ central: Central, willRead request: GATTReadRequest<Central>) -> ATTError?
+    func connection(_ central: Central, willRead request: GATTReadRequest<Central>) async -> ATTError?
     
-    func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) -> ATTError?
+    func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) async -> ATTError?
         
     func connection(_ central: Central, didWrite confirmation: GATTWriteConfirmation<Central>) async
 }
diff --git a/Sources/GATT/PeripheralProtocol.swift b/Sources/GATT/PeripheralProtocol.swift
@@ -38,11 +38,11 @@ public protocol PeripheralManager: AnyObject {
     /// Clears the local GATT database.
     func removeAllServices() async
     
-    var willRead: ((GATTReadRequest<Central>) -> ATTError?)? { get set }
+    var willRead: ((GATTReadRequest<Central>) async -> ATTError?)? { get set }
     
-    var willWrite: ((GATTWriteRequest<Central>) -> ATTError?)? { get set }
+    var willWrite: ((GATTWriteRequest<Central>) async -> ATTError?)? { get set }
     
-    var didWrite: ((GATTWriteConfirmation<Central>) -> ())? { get set }
+    var didWrite: ((GATTWriteConfirmation<Central>) async -> ())? { get set }
     
     /// Modify the value of a characteristic, optionally emiting notifications if configured on active connections.
     func write(_ newValue: Data, forCharacteristic handle: UInt16) async

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ internal final class GATTServerConnection <Socket: L2CAPSocket> {`
`88`	`88`	`value: value,`
`89`	`89`	`offset: offset`
`90`	`90`	`)`
`91`		`- return delegate?.connection(central, willRead: request)`
	`91`	`+ return await delegate?.connection(central, willRead: request)`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`private func willWrite(uuid: BluetoothUUID, handle: UInt16, value: Data, newValue: Data) async -> ATTError? {`
`@@ -100,7 +100,7 @@ internal final class GATTServerConnection <Socket: L2CAPSocket> {`
`100`	`100`	`value: value,`
`101`	`101`	`newValue: newValue`
`102`	`102`	`)`
`103`		`- return delegate?.connection(central, willWrite: request)`
	`103`	`+ return await delegate?.connection(central, willWrite: request)`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`private func didWrite(uuid: BluetoothUUID, handle: UInt16, value: Data) async {`
`@@ -121,9 +121,9 @@ internal protocol GATTServerConnectionDelegate: AnyObject {`
`121`	`121`
`122`	`122`	`func connection(_ central: Central, didDisconnect error: Error?) async`
`123`	`123`
`124`		`- func connection(_ central: Central, willRead request: GATTReadRequest<Central>) -> ATTError?`
	`124`	`+ func connection(_ central: Central, willRead request: GATTReadRequest<Central>) async -> ATTError?`
`125`	`125`
`126`		`- func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) -> ATTError?`
	`126`	`+ func connection(_ central: Central, willWrite request: GATTWriteRequest<Central>) async -> ATTError?`
`127`	`127`
`128`	`128`	`func connection(_ central: Central, didWrite confirmation: GATTWriteConfirmation<Central>) async`
`129`	`129`	`}`