swift-cancellationtoken

KO | EN

gitlite — search

#javascript #python #llm #go #android #machine-learning #deep-learning #linux #macos #windows #vue #awesome-list #ios #open-source

swift-cancellationtoken

(★ 20)

CancellationToken in Swift, modelled after the .NET version

swift-cancellationtoken Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A "cancellation token" is a little object that can be passed around to one or more asychronous tasks. This token can be used to indicate a user is no longer interested in the result of an asynchronous task.

By using a CancellationToken, the creation and cancellation of asynchronous tasks is separated into two distinct parts.

Usage
-----

1. Create a `CancellationTokenSource`.
2. Get the token from the source.
3. Pass the token to some asynchronous task.
4. _The asynchronous task may pass the token along to its subtasks._
5. When no longer interested in the result of the asynchronous task; Cancel the source. This cancellation will propagate to the token, and all copies of the token.
6. _The asynchrounous task may choose to cancel its operation and fail in its own way._

Example
-------

Here's an example based on network calls:

```swift
// Create a CancellationTokenSource and a CancellationToken
let source = CancellationTokenSource()
let token = source.token

// Start the asynchroneous downloading of a large file, passing in the cancellation token
request(largeFileUrl, cancellationToken: token)
  .response { response in
    if let error = response.error as? NSError {
      if error.domain == NSURLErrorDomain && error.code == NSURLErrorCancelled {
        print("The downloading was cancelled")
      }
    }
    else {
      print("The response is available: \(response)")
    }
  }

// Some time later, request cancellation
source.cancel()
```

Installation
------------

### Swift Package Manager

[SPM](https://swift.org/package-manager/) is a dependency manager for Swift projects.

Once you have SPM setup, add a dependency using Xcode or by editing Package.swift:

```swift
dependencies: [
    .package(url: "https://github.com/tomlokhorst/swift-cancellationtoken.git", from: "4.0.0"),
]
```

### CocoaPods

CancellationToken is available for both iOS and macOS. Using [CocoaPods](http://cocoapods.org), CancellationToken can be integrated into your Xcode project by specifying it in your `Podfile`:

```ruby
pod 'CancellationToken'
```

Then, run the following command:

```bash
$ pod install
```

### Manual

CancellationToken is just a single file, so instead of using SPM or CocoaPods, you could also just copy it into your project:

- [CancellationToken.swift](https://github.com/tomlokhorst/swift-cancellationtoken/blob/develop/Sources/CancellationToken/CancellationToken.swift)

Releases
--------

- **4.0.0** - 2021-03-05 - Update Package.swift to version 5, remove extensions
 - 3.2.0 - 2019-06-10 - Swift 5.1 in podspec
 - 3.1.0 - 2018-09-13 - Update to Swift 4.2, add tvOS support
 - **3.0.0** - 2018-03-27 - Cancellation now occurs automatically, when the source is released
 - 2.1.0 - 2017-11-27 - Lock internal state, for multithreading
 - **2.0.0** - 2017-10-30 - Swift 4 support, API cleanup
 - 1.1.0 - 2017-06-18 - Swift 3.2 support
 - **1.0.0** - 2017-02-23 - Cancel on `denit` of cancellation source
 - **0.3.0** - 2016-09-20 - Swift 3 support
 - **0.2.0** - 2015-09-11 - Swift 2 support
 - 0.1.1 - 2015-06-24 - No more circular references, fixes memory leak
 - **0.1.0** - 2015-03-31 - Initial public release
 - 0.0.0 - 2014-10-31 - Initial private version for project at [Q42](http://q42.com)

Licence & Credits
-----------------

CancellationToken is written by [Tom Lokhorst](https://twitter.com/tomlokhorst) and available under the [MIT license](https://github.com/tomlokhorst/swift-cancellationtoken/blob/master/LICENSE), so feel free to use it in commercial and non-commercial projects. This library modelled after the [.NET cancellation model](http://msdn.microsoft.com/en-us/library/dd997364.aspx).

swift-cancellationtoken

swift-cancellationtoken Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

swift-cancellationtoken

swift-cancellationtoken Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README