Swiftpack.co - Package - p4checo/APNSubGroupOperationQueue

APNSubGroupOperationQueue

license release platforms Build Status codecov.io Docs Carthage CocoaPods Swift 4.2

Swift & Obj-C µFramework consisting of NSOperationQueue subclasses which allow scheduling operations in serial subgroups inside concurrent queues.

In some scenarios, operations scheduled in an NSOperationQueue depend on a subset of other operations and should be processed in order, but don't depend on the remaining operations in the queue.

So far, this could be solved by:

  • using separate queues for each subset of dependent operations (can become unmanageable, wasteful)
  • defining the queue as serial (sub-optimal performance)

With this µFramework, a single operation queue can be used to schedule all operations and obtain the best of both worlds.

Dependent operations are grouped into "subgroups" which are guaranteed to be processed in a serial fashion inside each subgroup, while operations from other subgroups are processed concurrently (while serial inside their own subgroup) and regular operations (i.e. without defined subgroup) are processed concurrently with all others. This is done by leveraging NSOperations dependencies and using an auxiliary data structure to store all subgroups' operations.

Use

Swift

Single SubGroup Key type

@import APNSubGroupOperationQueue

let subGroupQueue = SubGroupOperationQueue<String>()

// schedule operations in subgroups "A", "B" and "C"
// these will run serially inside each subgroup, but concurrently with other subgroups' operations

subGroupQueue.addOperation(opA1, withKey: "A")
subGroupQueue.addOperation(opA2, withKey: "A")
subGroupQueue.addOperation(opA3, withKey: "A")

subGroupQueue.addOperations([opB1, opB2, opB3], withKey: "B")

subGroupQueue.addOperation({ /* opC1 */ }, withKey: "C")
subGroupQueue.addOperation({ /* opC2 */ }, withKey: "C")
subGroupQueue.addOperation({ /* opC3 */ }, withKey: "C")

// query current subgroup's operations (a snapshot)
let aOps = subGroupQueue["A"]
let bOps = subGroupQueue["B"]
let cOps = subGroupQueue.subGroupOperations(forKey: "C")

Multiple SubGroup Key types (via AnyHashable)

@import APNSubGroupOperationQueue

let dynamicSubGroupQueue = SubGroupQueue<AnyHashable> // or simply a `DynamicSubGroupOperationQueue`

dynamicSubGroupQueue.addOperation(opX1, withKey: "X")
dynamicSubGroupQueue.addOperation(opX2, withKey: "X")
dynamicSubGroupQueue.addOperation(opX3, withKey: "X")

dynamicSubGroupQueue.addOperations([opN1, opN2, opN3], withKey: 1337)

let date = Date()
dynamicSubGroupQueue.addOperation({ /* opD1 */ }, withKey: date)
dynamicSubGroupQueue.addOperation({ /* opD2 */ }, withKey: date)
dynamicSubGroupQueue.addOperation({ /* opD3 */ }, withKey: date)

// query current subgroup's operations (a snapshot)
let xOps = subGroupQueue["X"]
let nOps = subGroupQueue[1337]
let dOps = subGroupQueue.subGroupOperations(forKey: date)

Objective-C

@import APNSubGroupOperationQueue;

APNSubGroupOperationQueue *subGroupQueue = [APNSubGroupOperationQueue new];

// schedule operations in subgroups "A", "B" and "C"
// these will run serially inside each subgroup, but concurrently with other subgroups' operations
[subGroupQueue addOperation:opA1 withKey:@"A"];
[subGroupQueue addOperation:opA2 withKey:@"A"];
[subGroupQueue addOperation:opA2 withKey:@"A"];

[subGroupQueue addOperations::@[opB1, opB2, opB3] withKey:@"B" waitUntilFinished:false];

[subGroupQueue addOperationWithBlock:^{ /* opC1 */ } andKey:@"C"];
[subGroupQueue addOperationWithBlock:^{ /* opC2 */ } andKey:@"C"];
[subGroupQueue addOperationWithBlock:^{ /* opC3 */ } andKey:@"C"];

// query current subgroup's operations (a snapshot)
NSArray<NSOperation*> *aOps = [subGroupQueue subGroupOperationsForKey:@"A"];
NSArray<NSOperation*> *bOps = [subGroupQueue subGroupOperationsForKey:@"B"];
NSArray<NSOperation*> *cOps = [subGroupQueue subGroupOperationsForKey:@"C"];

// Objective-C uses a `DynamicSubGroupOperationQueue` which allows a more flexible usage, since keys only need to be `NSObject`'s (`AnyHashable`)
[subGroupQueue addOperations:@[opN1, opN2, opN3] withKey:@1337 waitUntilFinished:false];

NSDate *date = [NSDate date];
[subGroupQueue addOperationWithBlock:^{ /* opD1 */ } andKey:date];
[subGroupQueue addOperationWithBlock:^{ /* opD2 */ } andKey:date];

Compatibility

4.x (current)

  • iOS 10.0+, macOS 10.12, tvOS 10.0+, watchOS 3.0+
  • Xcode 10.2+
  • Swift 5.0

3.x

  • iOS 10.0+, macOS 10.12, tvOS 10.0+, watchOS 3.0+
  • Xcode 10
  • Swift 4.2

2.x

  • iOS 8.0+, macOS 10.9+, tvOS 9.0+, watchOS 2.0+
  • 2.3.0
    • Xcode 9.4
    • Swift 4.1
  • 2.2.0
    • Xcode 9
    • Swift 4.0
  • 2.1.0
    • Xcode 8
    • Swift 3

Integration

CocoaPods

Add APNSubGroupOperationQueue to your Podfile and run pod install:

# CocoaPods
pod 'APNSubGroupOperationQueue', '~> 4.0'

Carthage

Add APNSubGroupOperationQueue to your Cartfile (package dependency) or Cartfile.private (development dependency):

github "p4checo/APNSubGroupOperationQueue" ~> 4.0

Swift Package Manager

Add APNSubGroupOperationQueue to your Package.swift:

import PackageDescription

let package = Package(
  name: "HelloWorld",
  dependencies: [
    .package(url: "https://github.com/p4checo/APNSubGroupOperationQueue.git", from: "4.0.0"),
  ]
)

git Submodule

  1. Add this repository as a submodule.
  2. Drag APNSubGroupOperationQueue.xcodeproj into your project or workspace.
  3. Link your target against APNSubGroupOperationQueue.framework of your platform.
  4. If linking againts an Application target, ensure the framework gets copied into the bundle. If linking against a Framework target, the application linking to it should also include APNSubGroupOperationQueue.

Contributing

See CONTRIBUTING.

Github

link
Stars: 14
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

4.0.0 - Apr 26, 2019

  • Update to Swift 5 and Xcode 10.2.

  • Remove auth tokens from .travis.yml.

3.0.0 - Sep 17, 2018

  • Updated subgroup sync mechanism to an os_unfair_lock 🔒

  • Bumped the minimum OS versions:

    • iOS 10.0

    • macOS 10.12

    • tvOS 9.0

    • watchOS 3.0

  • Updated documentation 📝

  • Updated to Swift 4.2 (Xcode 10)

2.3.0 - Sep 15, 2018

  • Updated Swift version to 4.1 on the Podfile and README, removed .swift-version.

  • Improved .travis.yml to automatically deploy to CocoaPods and Carthage.

2.2.0 - Oct 31, 2017

  • Xcode 8 -> Xcode 9
  • Swift 3 -> Swift 4.0

2.1.0 - Feb 12, 2017

Made project pure Swift 😊 (but preserved Obj-C compatibility)

  • Removed APNSubGroupOperationQueue Obj-C class.
  • Created DynamicSubGroupOperationQueue Swift class, which is essentially a SubGroupOperationQueue<AnyHashable> without being generic in order to be usable from Obj-C.