File: DistributedDefaultExecutor.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 (53 lines) | stat: -rw-r--r-- 2,276 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Swift
import _Concurrency

@available(SwiftStdlib 5.9, *)
@usableFromInline
internal final class DistributedRemoteActorReferenceExecutor: SerialExecutor {
  static let _shared: DistributedRemoteActorReferenceExecutor = DistributedRemoteActorReferenceExecutor()
  static var sharedUnownedExecutor: UnownedSerialExecutor {
    UnownedSerialExecutor(ordinary: _shared)
  }

  internal init() {}

  @inlinable
  public func enqueue(_ job: consuming ExecutorJob) {
    let jobDescription = job.description
    fatalError("Attempted to enqueue ExecutorJob (\(jobDescription)) on executor of remote distributed actor reference!")
  }

  public func asUnownedSerialExecutor() -> UnownedSerialExecutor {
    UnownedSerialExecutor(ordinary: self)
  }
}

/// Obtain the unowned `SerialExecutor` that is used by by remote distributed actor references.
/// The executor is shared between all remote default executor remote distributed actors,
/// and it will crash if any job is enqueued on it.
///
/// It is possible to obtain the executor e.g. for logging or general debugging,
/// however attempting to enqueue work on what might potentially be a remote actor
/// is a programming error and therefore will crash if the actor is potentially.
///
/// If one intends to use a distributed actor's executor to schedule work on it,
/// one should programmatically ensure that that actor is local, e.g. using the `whenLocal`
/// functionality of distributed actors, or by other means (e.g. "knowing that it definitely must be local")
@available(SwiftStdlib 5.9, *)
public func buildDefaultDistributedRemoteActorExecutor<Act>(
    _ actor: Act
) -> UnownedSerialExecutor where Act: DistributedActor {
  return DistributedRemoteActorReferenceExecutor.sharedUnownedExecutor
}