Skip to content

Commit

Permalink
Improving README
Browse files Browse the repository at this point in the history
  • Loading branch information
FabrizioBrancati committed Oct 30, 2018
1 parent fd49ae3 commit 7c50467
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -51,7 +51,8 @@ Here is the list of all the features:
- [x] Create semaphores
- [x] Create and handle schedules
- [x] Automatically or manually retry an operation
- [ ] Ability to restore uncompleted operations
- [x] Ability to restore uncompleted operations
- [ ] Improve the state restoration feature
- [ ] Throttling between each automatic operation retry
- [ ] Data layer that every operation inside an operation queue can access

Expand Down Expand Up @@ -167,6 +168,7 @@ Usage
- [Manually Retry an Operation](https://github.com/FabrizioBrancati/Queuer#manually-retry-an-operation)
- [Scheduler](https://github.com/FabrizioBrancati/Queuer#scheduler)
- [Semaphore](https://github.com/FabrizioBrancati/Queuer#semaphore)
- [Queue State Restoration](https://github.com/FabrizioBrancati/Queuer#queue-state-restoration)

### Shared Queuer

Expand Down Expand Up @@ -366,6 +368,13 @@ concurrentOperation.addToQueue(queue)
semaphore.wait()
```

### Queue State Restoration (Beta)
To enable the Queue Restoration feature you must use `ConcurrentOperation` with a unique (non-nil) `name` property.
Currently this feature allows you to save the current state of you queue, like: `name`, `progress` and `dependencies`.<br>
The `progress` property allows to save the current state of the `Operation` progress. Update it constantly during the `Operation` execution.<br>
Call `Queuer.state(of: OperationQueue)` or `operationQueue.state()` to get the `QueueStateList` aka: Array of `OperationState`s.<br>
It's up to you save and retrieve this list, and create the queue correctly.

Documentation
=============

Expand Down

0 comments on commit 7c50467

Please sign in to comment.