Swiftpack.co - Package - lucas34/SwiftQueue

SwiftQueue

Schedule tasks with constraints made easy.

Awesome platform swift travis codecov pod Carthage compatible Swift Package Manager compatible Documentation

SwiftQueue is a job scheduler for iOS inspired by popular android libraries like android-priority-jobqueue or android-job. It allows you to run your tasks with run and retry constraints.

Library will rely on Operation and OperationQueue to make sure all tasks will run in order. Don't forget to check our WIKI.

Features

  • [x] Sequential execution
  • [x] Concurrent run
  • [x] Persistence
  • [x] Cancel all, by id or by tag
  • [x] Start / Stop queue

Job Constraints:

  • [x] Delay
  • [x] Deadline
  • [x] Internet
  • [x] Charging
  • [x] Single instance in queue
  • [x] Retry: Max count, exponential backoff
  • [x] Periodic: Max run, interval delay

Requirements

  • iOS 8.0+, watchOS 2.0+, macOS 10.10+, tvOS 9.0+
  • Xcode 7.3

Installation

SwiftPackageManager (SPM)

To integrate using Apple's Swift package manager, add the following as a dependency to your Package.swift:

.package(url: "https://github.com/lucas34/SwiftQueue.git", .upToNextMajor(from: "4.0.0"))

Carthage

SwiftQueue is carthage compatible. Add the following entry in your Cartfile:

github "lucas34/SwiftQueue"

Then run carthage update.

CocoaPods

You can use CocoaPods to install SwiftQueue by adding it to your Podfile:

platform :ios, '8.0'
use_frameworks!
pod 'SwiftQueue'

In your application, simply import the library

import SwiftQueue

Example

This example will simply wrap an api call. Create your custom job by extending Job with onRun, onRetry and onRemove callbacks.

// A job to send a tweet
class SendTweetJob: Job {
    
    // Type to know which Job to return in job creator
    static let type = "SendTweetJob"
    // Param
    private let tweet: [String: Any]

    required init(params: [String: Any]) {
        // Receive params from JobBuilder.with()
        self.tweet = params
    }

    func onRun(callback: JobResult) {
        let api = Api()
        api.sendTweet(data: tweet).execute(onSuccess: {
            callback.done(.success)
        }, onError: { error in
            callback.done(.fail(error))
        })
    }

    func onRetry(error: Error) -> RetryConstraint {
        // Check if error is non fatal
        return error is ApiError ? RetryConstraint.cancel : RetryConstraint.retry(delay: 0) // immediate retry
    }

    func onRemove(result: JobCompletion) {
        // This job will never run anymore  
        switch result {
            case .success:
                // Job success
            break
            
            case .fail(let error):
                // Job fail
            break
       
        }
    }
}

Create your SwiftQueueManager and keep the reference. If you want to cancel a job it has to be done with the same instance.

let manager = SwiftQueueManagerBuilder(creator: TweetJobCreator()).build()

Schedule your job and specify the constraints.

JobBuilder(type: SendTweetJob.type)
        // Requires internet to run
        .internet(atLeast: .cellular)
        // params of my job
        .with(params: ["content": "Hello world"])
        // Add to queue manager
        .schedule(manager: manager)

Bind your job type with an actual instance.

class TweetJobCreator: JobCreator {

    // Base on type, return the actual job implementation
    func create(type: String, params: [String: Any]?) -> Job {
        // check for job and params type
        if type == SendTweetJob.type  {
            return SendTweetJob(params: params)
        } else {
            // Nothing match
            // You can use `fatalError` or create an empty job to report this issue.
            fatalError("No Job !")
        }
    }
}

3rd Party Extensions

Contributors

We would love you for the contribution to SwiftQueue, check the LICENSE file for more info.

License

Distributed under the MIT license. See LICENSE for more information.

Github

link
Stars: 143
Help us keep the lights on

Dependencies

Used By

Total: 1

Releases

3.2.0 - Jun 9, 2019

New features

  • Job execution timeout constraint (#50)
  • Exponential backoff with max delay (#226)
  • Better threading configuration for Queue and Manager (#228) (#229) (#230)
  • Jobs can be enqueue from manager with .enqueue(JobInfo) (#231)

3.1.0 - May 13, 2019

New features

  • Job status listener (#217)
  • Allow a queue to run multiple jobs in parallel (#215)

Breaking changes

  • Rename synchronous to initInBackground (#213)
  • Rename group() to parallel() (#212)

Enhancement

  • Better control on running for duplicate job constraint (#219)
  • Add no logger by default (#211)

3.0.0 - Apr 4, 2019

Chore

  • Swift 5 support. Source was already compatible 🙌 (#206)
  • Drop Linux support (#206)

2.4.0 - Jan 20, 2019

2.4.0

Linux Support 🙌

  • SwiftQueue is now avaiable on Linux (#189)

Chore

  • Bump Reachability to 4.3.0 (#190)

2.3.0 - Sep 21, 2018

Bug Fix

  • Revise charging constraint implementation (#177)

Chore

  • Swift 4.2 and Xcode 10 support (#181) (#182) (#187)
  • Bump Reachability to 4.2.1 for carthage (#174)
  • Bump Reachability and change origin for SPM (#175)
  • Bump Rechability for pod (#172)