Jobs
A minimalistic job system in Swift, for Swift
Table of Contents
Integration
Update your Package.swift file.
.package(url: "https://github.com/BrettRToomey/Jobs.git", from: "1.1.1")
Getting started
๐
Creating a new Job is as simple as:
Jobs.add(interval: .seconds(4)) {
print("๐ I'm printed every 4 seconds!")
}
Intervals
โฒ
The Duration enumeration currently supports .seconds, hours, .days and .weeks.
Jobs.add(interval: .days(5)) {
print("See you every 5 days.")
}
Syntax candy
๐ญ
It's possible to create a Duration from an Int and a Double.
10.seconds // `Duration.seconds(10)`
4.hours // `Duration.hours(4)`
2.days // `Duration.days(2)`
3.weeks // `Duration.weeks(3)`
Starting a job
๐ฌ
By default, Jobs are started automatically, but if you wish to start one yourself, even at a later point in time, just do the following:
let job = Jobs.add(interval: 2.seconds, autoStart: false) {
print("I wasn't started right away.")
}
//...
job.start()
Stopping a job
โ
Giving up has never been so easy!
job.stop()
One-off jobs
If you just want to asynchronously run a job, but not repeat it you can use the oneoff functions.
Jobs.oneoff {
print("Sadly, I'm not a phoenix.")
}
How about waiting a little?
Jobs.oneoff(delay: 10.seconds) {
print("I was delayed by 10 seconds.")
}
Error handling
โ
Sometimes jobs can fail, that's okay, we have you covered.
Jobs.add(
interval: 10.seconds,
action: {
throw Error.someError
},
onError: { error in
print("caught an error: \(error)")
return RecoverStrategy.default
}
)
Retry on failure
โญ๏ธ
By default, jobs will be attempted again after a five second delay. If you wish to override this behavior you must first implement an onError handler and return one of the following RecoveryStrategy cases.
.none //do not retry
.default //retry after 5 seconds
.retry(after: Duration) //retry after specified duration
Here's a small sample:
enum Error: Swift.Error {
case recoverable
case abort
}
Jobs.add(
interval: 1.days,
action: {
//...
},
onError: { error in
switch error {
//we cannot recover from this
case .abort:
//do not retry
return .none
//we can recover from this
case .recoverable:
//... recovery code
//try again in 15 seconds
return .retry(after: 15.seconds)
}
}
)
416 Dec 16, 2022
13.9k Dec 29, 2022
850 Dec 2, 2022
258 Oct 6, 2022
4 Apr 25, 2022
1 Aug 23, 2022
3.6k Dec 31, 2022
397 Oct 30, 2022
1.9k Dec 22, 2022
22.4k Jan 3, 2023
262 Jun 29, 2022
908 Dec 2, 2022
451 Jul 28, 2022
46 Jan 29, 2022
925 Nov 17, 2022
7.6k Dec 27, 2022
2k Dec 5, 2022
68 Jul 25, 2022