File: Condition.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 (56 lines) | stat: -rw-r--r-- 1,682 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
48
49
50
51
52
53
54
55
56
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import Foundation

/// Simple wrapper around NSCondition.
/// - SeeAlso: NSCondition
public struct Condition {
    private let _condition = NSCondition()

    /// Create a new condition.
    public init() {}

    /// Wait for the condition to become available.
    public func wait() {
        _condition.wait()
    }

    /// Blocks the current thread until the condition is signaled or the specified time limit is reached.
    ///
    /// - Returns: true if the condition was signaled; otherwise, false if the time limit was reached.
    public func wait(until limit: Date) -> Bool {
        return _condition.wait(until: limit)
    }

    /// Signal the availability of the condition (awake one thread waiting on
    /// the condition).
    public func signal() {
        _condition.signal()
    }

    /// Broadcast the availability of the condition (awake all threads waiting
    /// on the condition).
    public func broadcast() {
        _condition.broadcast()
    }

    /// A helper method to execute the given body while condition is locked.
    /// - Note: Will ensure condition unlocks even if `body` throws.
    public func whileLocked<T>(_ body: () throws -> T) rethrows -> T {
        _condition.lock()
        defer { _condition.unlock() }
        return try body()
    }
}

#if compiler(>=5.7)
extension Condition: Sendable {}
#endif