SwiftQueue
Schedule tasks with constraints made easy.
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
- Sequential execution
- Concurrent run
- Persistence
- Cancel all, by id or by tag
- Delay
- Deadline
- Internet constraint
- Single instance in queue
- Retry: Max count, exponential backoff
- Periodic: Max run, interval delay
- Start / Stop queue
Requirements
- iOS 8.0+, watchOS 2.0+, macOS 10.10+, tvOS 9.0+
- Xcode 7.3
Installation
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 !")
}
}
}
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.