File: DispatchQueue%2BWithFuture.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (47 lines) | stat: -rw-r--r-- 1,714 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2020 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

import Dispatch

extension DispatchQueue {
    /// Schedules a work item for immediate execution and immediately returns with an `EventLoopFuture` providing the
    /// result. For example:
    ///
    ///     let futureResult = DispatchQueue.main.asyncWithFuture(eventLoop: myEventLoop) { () -> String in
    ///         callbackMayBlock()
    ///     }
    ///     try let value = futureResult.wait()
    ///
    /// - parameters:
    ///     - eventLoop: the `EventLoop` on which to proceses the IO / task specified by `callbackMayBlock`.
    ///     - callbackMayBlock: The scheduled callback for the IO / task.
    /// - returns a new `EventLoopFuture<ReturnType>` with value returned by the `block` parameter.
    @inlinable
    public func asyncWithFuture<NewValue>(
        eventLoop: EventLoop,
        _ callbackMayBlock: @escaping () throws -> NewValue
    ) -> EventLoopFuture<NewValue> {
        let promise = eventLoop.makePromise(of: NewValue.self)

        self.async {
            do {
                let result = try callbackMayBlock()
                promise.succeed(result)
            } catch {
                promise.fail(error)
            }
        }
        return promise.futureResult
    }
}