File: cross_thread_handle.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (146 lines) | stat: -rw-r--r-- 5,508 bytes parent folder | download | duplicates (8)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_HEAP_CROSS_THREAD_HANDLE_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_HEAP_CROSS_THREAD_HANDLE_H_

#include "third_party/blink/renderer/platform/heap/cross_thread_handle_internal.h"

namespace blink {

// A handle object that may be used to hold a garbage collection object from a
// different thread than the object was created on. The handle supports
// thread-safe copy/move/destruction. The underlying object may only be used
// from the creation thread.
//
// Example posting to a static method that forwards back to an instance method
// on the main thread:
// ```
// class PingPong final : public GarbageCollected<PingPong> {
//  public:
//   void Ping() {
//    DCHECK(IsMainThread());
//    worker_pool::PostTask(FROM_HERE,
//                          CrossThreadBindOnce(&PingPong::PongOnBackground,
//                                              MakeCrossThreadHandle(this),
//                                              std::move(task_runner_)));
//   }
//
//  private:
//   const scoped_refptr<base::SingleThreadTaskRunner> task_runner_ =
//       GetTaskRunner();
//
//   void DoneOnMainThread() { DCHECK(IsMainThread()); }
//
//   static void PongOnBackground(
//      CrossThreadHandle<PingPong> ping_pong,
//      scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
//    DCHECK(!IsMainThread());
//    PostCrossThreadTask(
//        *task_runner, FROM_HERE,
//        CrossThreadBindOnce(&PingPong::DoneOnMainThread,
//                            MakeUnwrappingCrossThreadWeakHandle(
//                                std::move(ping_pong))));
//   }
// };
// ```
template <typename T>
using CrossThreadHandle = internal::
    BasicCrossThreadHandle<T, internal::StrongCrossThreadHandleWeaknessPolicy>;

// Utility function creating a `CrossThreadHandle` tracking the current source
// location position in debugging configurations.
template <typename T>
CrossThreadHandle<T> MakeCrossThreadHandle(
    T* value,
    const CrossThreadHandleLocation& loc =
        CROSS_THREAD_HANDLE_LOCATION_FROM_HERE) {
  return CrossThreadHandle<T>(value);
}

// A weak handle object with similar restrictions as `CrossThreadHandle`.
// The object is only held alive weakly, meaning that the object may be
// reclaimed by the garbage collector. As a consequence, any value retrieved
// from this handle must be checked against nullptr.
template <typename T>
using CrossThreadWeakHandle = internal::
    BasicCrossThreadHandle<T, internal::WeakCrossThreadHandleWeaknessPolicy>;

// Utility function creating a `CrossThreadWeakHandle` tracking the current
// source location position in debugging configurations.
template <typename T>
CrossThreadWeakHandle<T> MakeCrossThreadWeakHandle(
    T* value,
    const CrossThreadHandleLocation& loc =
        CROSS_THREAD_HANDLE_LOCATION_FROM_HERE) {
  return CrossThreadWeakHandle<T>(value);
}

// A version of `CrossThreadHandle` that automatically unwraps into `T*` on
// invocation of a bound function. This is useful for binding against regular
// instance methods of a type.
template <typename T>
using UnwrappingCrossThreadHandle = internal::BasicUnwrappingCrossThreadHandle<
    T,
    internal::StrongCrossThreadHandleWeaknessPolicy>;

// Utility function creating an `UnwrappingCrossThreadHandle`.
template <typename T>
UnwrappingCrossThreadHandle<T> MakeUnwrappingCrossThreadHandle(
    T* value,
    const CrossThreadHandleLocation& loc =
        CROSS_THREAD_HANDLE_LOCATION_FROM_HERE) {
  return UnwrappingCrossThreadHandle<T>(value, loc);
}

// Utility function creating an `UnwrappingCrossThreadHandle`.
template <typename T>
UnwrappingCrossThreadHandle<T> MakeUnwrappingCrossThreadHandle(
    const CrossThreadHandle<T>& handle) {
  return UnwrappingCrossThreadHandle<T>(handle);
}

// Utility function creating an `UnwrappingCrossThreadHandle`.
template <typename T>
UnwrappingCrossThreadHandle<T> MakeUnwrappingCrossThreadHandle(
    CrossThreadHandle<T>&& handle) {
  return UnwrappingCrossThreadHandle<T>(std::move(handle));
}

// A version of `CrossThreadWeakHandle` that automatically unwraps into `T*`
// on invocation of a bound function. This is useful for binding against regular
// instance methods of a type.
template <typename T>
using UnwrappingCrossThreadWeakHandle =
    internal::BasicUnwrappingCrossThreadHandle<
        T,
        internal::WeakCrossThreadHandleWeaknessPolicy>;

// Utility function creating an `UnwrappingCrossThreadHandle`.
template <typename T>
UnwrappingCrossThreadWeakHandle<T> MakeUnwrappingCrossThreadWeakHandle(
    T* value,
    const CrossThreadHandleLocation& loc =
        CROSS_THREAD_HANDLE_LOCATION_FROM_HERE) {
  return UnwrappingCrossThreadWeakHandle<T>(value, loc);
}

// Utility function creating an `UnwrappingCrossThreadHandle`.
template <typename T>
UnwrappingCrossThreadWeakHandle<T> MakeUnwrappingCrossThreadWeakHandle(
    const CrossThreadWeakHandle<T>& handle) {
  return UnwrappingCrossThreadWeakHandle<T>(handle);
}

// Utility function creating an `UnwrappingCrossThreadHandle`.

template <typename T>
UnwrappingCrossThreadWeakHandle<T> MakeUnwrappingCrossThreadWeakHandle(
    CrossThreadWeakHandle<T>&& handle) {
  return UnwrappingCrossThreadWeakHandle<T>(std::move(handle));
}

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_HEAP_CROSS_THREAD_HANDLE_H_