Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swingdev/rxswiftautoretry
https://github.com/swingdev/rxswiftautoretry
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/swingdev/rxswiftautoretry
- Owner: SwingDev
- License: mit
- Created: 2018-11-21T12:57:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-04T08:28:58.000Z (over 5 years ago)
- Last Synced: 2025-01-01T14:43:10.593Z (about 1 month ago)
- Language: Swift
- Size: 430 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RxSwiftAutoRetry
[](https://cocoapods.org/pods/RxSwiftAutoRetry)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/RxSwiftAutoRetry)
[](https://cocoapods.org/pods/RxSwiftAutoRetry)
RxSwiftAutoRetry is an extension to [RxSwift](https://github.com/ReactiveX/RxSwift) - a well-known Reactive Swift framework.
It allows user to retry observable after exponential time. It also provides simple way to randomize time of delay.
## Example
To run the example project, clone the repo, and run `pod install` from the root project directory first.
## Tests
To run tests, run `carthage update` from the root project directory first.
## Requirements
* iOS 8.0+
* macOS 10.9+
## Installation
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager, which simplifies adding 3rd-party libraries. To install it, add the following line to your Podfile:
```ruby
pod 'RxSwiftAutoRetry'
```
Then, you need to run below comand to install framework into your project:
```ruby
pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is decentralized dependency manager which allows you to keep your dependencies in compiled format.
1. To install it, add following line to your Cartfile:
```ruby
github 'SwingDev/RxSwiftAutoRetry'
```
2. Next, run `carthage update`
3. On your application targets’ **Build Phases** tab, in the **Link Binary With Libraries** section, drag and drop `RxSwift.framework` and `RxSwiftAutoRetry.framework` from the Carthage/Build folder on disk.
4. On your application targets’ **Build Phases** settings tab, click the + icon and choose **New Run Script Phase**. Create a Run Script in which you specify your shell (ex: /bin/sh), add the following contents to the script area below the shell:
```
/usr/local/bin/carthage copy-frameworks
```
5. Add the paths to the frameworks you want to use under “Input Files". For example:
```
$(SRCROOT)/Carthage/Build//RxSwift.framework
$(SRCROOT)/Carthage/Build//RxSwiftAutoRetry.framework
```
### Swift Package Manager
[Swift Package Manager](https://swift.org/package-manager/) is is a tool for managing the distribution of Swift code and integrating it into compiler.
**It only works with macOS.**
Add dependency to your `Package.swift` file:
``` swift
dependencies: [
.package(url: "https://github.com/SwingDev/RxSwiftAutoRetry.git", from: "0.9"))
]
```
Then, run below command:
```ruby
pod install
```
## Usage
See sample project in [Example](ExampleApp/) folder.
`retryExponentially` is extension method for RxSwift framework (in case to use this method please import **RxSwift** library.)
Usually using this method looks like it:
```Swift
observable.retryExponentially()
```
This method provides set of default values for parameters so its behavior can be customized:
```Swift
observable.retryExponentially(2, with: 0.9...1.1, scheduler: scheduler) { error in
//Add code
}
```
##### Parameters
* **maxAttemptCount** - Maximum number of times to repeat the sequence.
* **jitter** - Multiplier which randomize delay time. Randomizing value is chosen from given range.
* **scheduler** - Scheduler on which the delay will be conducted
* **onRetry** - Action which will be invoked after delay on every retry. This is optional parameter.
##### Default values
* **maxAttemptCount**: `3`
* **jitter**: `0.9...1.1`
* **scheduler**: `ConcurrentDispatchQueueScheduler(queue: DispatchQueue.global())`
* **onRetry**: `nil`
## License
RxSwiftAutoRetry is available under the MIT license. See the LICENSE file for more info.