Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucas34/SwiftQueue
Job Scheduler for IOS with Concurrent run, failure/retry, persistence, repeat, delay and more
https://github.com/lucas34/SwiftQueue
constraints delay job job-scheduler operation operationqueue persist persistence queue scheduler swift
Last synced: 27 days ago
JSON representation
Job Scheduler for IOS with Concurrent run, failure/retry, persistence, repeat, delay and more
- Host: GitHub
- URL: https://github.com/lucas34/SwiftQueue
- Owner: lucas34
- License: mit
- Created: 2017-08-10T11:21:35.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T01:48:28.000Z (3 months ago)
- Last Synced: 2024-07-21T04:21:30.278Z (about 2 months ago)
- Topics: constraints, delay, job, job-scheduler, operation, operationqueue, persist, persistence, queue, scheduler, swift
- Language: Swift
- Homepage:
- Size: 773 KB
- Stars: 407
- Watchers: 8
- Forks: 42
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - SwiftQueue - Job Scheduler with Concurrent run, failure/retry, persistence, repeat, delay and more. (Concurrency / Linter)
- awesome-ios-star - SwiftQueue - Job Scheduler with Concurrent run, failure/retry, persistence, repeat, delay and more. (Concurrency / Linter)
README
# SwiftQueue
> Schedule tasks with constraints made easy.
[](https://github.com/sindresorhus/awesome)
[](https://cocoapods.org/pods/SwiftQueue)
[](https://swift.org)
[](https://codecov.io/gh/lucas34/SwiftQueue)
[](https://cocoapods.org/pods/SwiftQueue)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](https://lucas34.github.io/SwiftQueue)
`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**](https://github.com/lucas34/SwiftQueue/wiki).
## Features
- [x] Sequential or Concurrent execution
- [x] Persistence
- [x] Cancel all, by id or by tag
- [x] Start / Stop queue
Job Constraints:
- [x] Delay
- [x] Deadline
- [x] Timeout
- [x] Internet
- [x] Charging
- [x] Single instance in queue
- [x] Retry: Max count, exponential backoff
- [x] Periodic: Max run, interval delay
- [x] *Experimental* Foreground or Background execution
## Requirements
- iOS 8.0+, watchOS 2.0+, macOS 10.10+, tvOS 9.0+
- Xcode 11.0
## Installation
#### SwiftPackageManager (SPM)
To integrate using Apple's Swift package manager, add the following as a dependency to your Package.swift:
```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](https://cocoapods.org/pods/SwiftQueue) to install `SwiftQueue` by adding it to your `Podfile`:
```ruby
platform :ios, '8.0'
use_frameworks!
pod 'SwiftQueue'
```
In your application, simply import the library
``` swift
import SwiftQueue
```
## Example
This example will simply wrap an api call. Create your custom job by extending `Job` with `onRun`, `onRetry` and `onRemove` callbacks.
```swift
// 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.
```swift
let manager = SwiftQueueManagerBuilder(creator: TweetJobCreator()).build()
```
Schedule your job and specify the constraints.
```swift
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.
```swift
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
* [SQLitePersisterForSwiftQueue](https://github.com/gumbright/SQLitePersisterForSwiftQueue): A SQLite3 based persister for SwiftQueue
## Contributors
We would love you for the contribution to **SwiftQueue**, check the [`LICENSE`](LICENSE) file for more info.
* [Lucas Nelaupe](http://www.lucas-nelaupe.fr/) - [@lucas34990](https://twitter.com/lucas34990)
## License
Distributed under the MIT license. See [`LICENSE`](LICENSE) for more information.