Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JARMourato/Dispatch
Just a tiny library to make using GCD easier and intuitive
https://github.com/JARMourato/Dispatch
async gdc multithreading swift
Last synced: about 1 month ago
JSON representation
Just a tiny library to make using GCD easier and intuitive
- Host: GitHub
- URL: https://github.com/JARMourato/Dispatch
- Owner: JARMourato
- License: mit
- Archived: true
- Created: 2016-05-11T18:19:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-14T19:26:09.000Z (almost 7 years ago)
- Last Synced: 2024-05-22T15:21:36.487Z (4 months ago)
- Topics: async, gdc, multithreading, swift
- Language: Swift
- Homepage:
- Size: 495 KB
- Stars: 178
- Watchers: 12
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Dispatch - Just a tiny library to make using GCD easier and intuitive. (GCD / Getting Started)
- awesome-ios-star - Dispatch - Just a tiny library to make using GCD easier and intuitive. (GCD / Getting Started)
README
## Build Status
|**Branch**| **Status** |
|---|---|
|**master** |[](https://travis-ci.org/Swiftification/Dispatch)|
|**develop** |[](https://travis-ci.org/Swiftification/Dispatch)|
## Dispatch
[](https://developer.apple.com/swift/)
[](https://github.com/DynamicThreads/Dispatch/master/LICENSE)
[](https://github.com/Carthage/Carthage)
[](https://codebeat.co/projects/github-com-swiftification-dispatch)
[](https://codecov.io/gh/S/Dispatch)
#### Note:
Dispatch requires swift 3.0. Use version 1.0.0 for swift 2.3 or version 0.9.8 for swift 2.2.
## Installation
#### CocoaPods
Dispatch is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'Dispatch'
```
## Carthage
----------------
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate Dispatch into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "Swiftification/Dispatch"
```
Run `carthage update` to fetch the Dispatch library and drag into your Xcode project.
And then simply
``` swift
import DispatchFramework
```
And your good to go!
#### Manually
1. Download and drop ```Dispatch.swift``` anywhere you like in your project.
2. That's it.
## Usage
### Basic
```swift
Dispatch.async(dispatch_get_main_queue()) {
//Code to be run on the main thread
}
```
##### Or using the helpers provided by Dispatch.Queue enum
```swift
Dispatch.async(Queue.main) {
//Code to be run on the main thread
}
```
##### Or using the overloaded method to run on the main thread
```swift
Dispatch.async {
//Code to be run on the main thread
}
```
### Types of Dispatch
#### Async
```swift
Dispatch.async(Queue.main) {
//Code to be run on the main thread
}
```
#### Sync
```swift
let someCustomQueue = dispatch_queue_create("custom.queue.dispatch", DISPATCH_QUEUE_CONCURRENT)
Dispatch.sync(someCustomQueue) {
//Code to be synchronously on someCustomQueue
}
```
#### After
```swift
Dispatch.after(1.0, queue: Queue.main) {
//Code to be run on the main thread after 1 second
}
```
##### Or using the overloaded method to run on the main thread
```swift
Dispatch.after(1.0) {
//Code to be run on the main thread after 1 second
}
```
#### Once
```swift
let token : dispatch_once_t
Dispatch.once(&token) {
//Code to be run only once in App lifetime
}
```
### Queue Helpers
#### Main queue
```swift
let mainQueue = Queue.main
```
#### Custom queue
```swift
let customConcurrentQueue = Queue.custom("custom.concurrent.queue.dispatch", Queue.Atribute.concurrent)
let customSerialQueue = Queue.custom("custom.serial.queue.dispatch", Queue.Atribute.serial)
```
#### Global queues
```swift
let priority = 0 // or you use one of the Global priorities (ex: Queue.Priority.UserInteractive)
let globalQueue = Queue.global(priority)
// For comodity there are helpers for getting the Global queues
let globalUserInteractiveQueue = Queue.globalUserInteractive
let globalUserInitiatedQueue = Queue.globalUserInitiated
let globalUtilityQueue = Queue.globalUtility
let globalBackgroundQueue = Queue.globalBackground
```
## TODO
- [X] Carthage compatible
- [X] Chainable methods
- [X] Travis CI
- [X] Unit Tests
- [ ] More examples
## Communication
- If you **find a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Authors
- João Mourato, [email protected]
- Gabriel Peart
## License
Dispatch is available under the MIT license. See the LICENSE file for more info.