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
|
// Copyright 2020 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_MOJO_HEAP_MOJO_ASSOCIATED_REMOTE_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_MOJO_HEAP_MOJO_ASSOCIATED_REMOTE_H_
#include <utility>
#include "base/task/sequenced_task_runner.h"
#include "mojo/public/cpp/bindings/associated_remote.h"
#include "third_party/blink/renderer/platform/context_lifecycle_observer.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_wrapper_mode.h"
#include "third_party/blink/renderer/platform/mojo/mojo_binding_context.h"
namespace blink {
// HeapMojoAssociatedRemote is a wrapper for mojo::AssociatedRemote to be owned
// by a garbage-collected object. Blink is expected to use
// HeapMojoAssociatedRemote by default. HeapMojoAssociatedRemote must be
// associated with context. HeapMojoAssociatedRemote's constructor takes context
// as a mandatory parameter. HeapMojoAssociatedRemote resets the mojo connection
// when the associated ExecutionContext is detached.
// TODO(crbug.com/1058076) HeapMojoWrapperMode should be removed once we ensure
// that the interface is not used after ContextDestroyed().
template <typename Interface,
HeapMojoWrapperMode Mode = HeapMojoWrapperMode::kWithContextObserver>
class HeapMojoAssociatedRemote {
DISALLOW_NEW();
public:
explicit HeapMojoAssociatedRemote(ContextLifecycleNotifier* notifier)
: wrapper_(MakeGarbageCollected<Wrapper>(notifier)) {}
HeapMojoAssociatedRemote(const HeapMojoAssociatedRemote&) = delete;
HeapMojoAssociatedRemote& operator=(const HeapMojoAssociatedRemote&) = delete;
HeapMojoAssociatedRemote(HeapMojoAssociatedRemote&&) = default;
HeapMojoAssociatedRemote& operator=(HeapMojoAssociatedRemote&&) = default;
// Methods to redirect to mojo::AssociatedRemote.
using Proxy = typename Interface::Proxy_;
Proxy* operator->() const { return get(); }
Proxy* get() const { return wrapper_->associated_remote().get(); }
bool is_bound() const { return wrapper_->associated_remote().is_bound(); }
explicit operator bool() const { return is_bound(); }
bool is_connected() const {
return wrapper_->associated_remote().is_connected();
}
void reset() { wrapper_->associated_remote().reset(); }
void ResetWithReason(uint32_t custom_reason, const std::string& description) {
wrapper_->associated_remote().ResetWithReason(custom_reason, description);
}
void set_disconnect_handler(base::OnceClosure handler) {
wrapper_->associated_remote().set_disconnect_handler(std::move(handler));
}
void set_disconnect_with_reason_handler(
mojo::ConnectionErrorWithReasonCallback handler) {
wrapper_->associated_remote().set_disconnect_with_reason_handler(
std::move(handler));
}
[[nodiscard]] mojo::PendingAssociatedReceiver<Interface>
BindNewEndpointAndPassReceiver(
scoped_refptr<base::SequencedTaskRunner> task_runner) {
DCHECK(task_runner);
return wrapper_->associated_remote().BindNewEndpointAndPassReceiver(
std::move(task_runner));
}
[[nodiscard]] mojo::PendingAssociatedReceiver<Interface>
BindNewEndpointAndPassDedicatedReceiver() {
return wrapper_->associated_remote()
.BindNewEndpointAndPassDedicatedReceiver();
}
void Bind(mojo::PendingAssociatedRemote<Interface> pending_associated_remote,
scoped_refptr<base::SequencedTaskRunner> task_runner) {
DCHECK(task_runner);
wrapper_->associated_remote().Bind(std::move(pending_associated_remote),
std::move(task_runner));
}
void FlushForTesting() {
return wrapper_->associated_remote().FlushForTesting();
}
void Trace(Visitor* visitor) const { visitor->Trace(wrapper_); }
private:
// Garbage collected wrapper class to add ContextLifecycleObserver.
class Wrapper final : public GarbageCollected<Wrapper>,
public ContextLifecycleObserver {
public:
explicit Wrapper(ContextLifecycleNotifier* notifier) {
SetContextLifecycleNotifier(notifier);
}
Wrapper(const Wrapper&) = delete;
Wrapper& operator=(const Wrapper&) = delete;
Wrapper(Wrapper&&) = default;
Wrapper& operator=(Wrapper&&) = default;
void Trace(Visitor* visitor) const override {
ContextLifecycleObserver::Trace(visitor);
}
mojo::AssociatedRemote<Interface>& associated_remote() {
return associated_remote_;
}
// ContextLifecycleObserver methods
void ContextDestroyed() override {
if (Mode == HeapMojoWrapperMode::kWithContextObserver)
associated_remote_.reset();
}
private:
mojo::AssociatedRemote<Interface> associated_remote_;
};
Member<Wrapper> wrapper_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_MOJO_HEAP_MOJO_ASSOCIATED_REMOTE_H_
|